envoy_extensions_filters_http_compressor_v3

Documentation

Index

• Variables
• type Compressor
  • func (*Compressor) Descriptor() ([]byte, []int)
  • func (x *Compressor) GetCompressorLibrary() *v3.TypedExtensionConfig
  • func (x *Compressor) GetContentLength() *wrappers.UInt32Value
  • func (x *Compressor) GetContentType() []string
  • func (x *Compressor) GetDisableOnEtagHeader() bool
  • func (x *Compressor) GetRemoveAcceptEncodingHeader() bool
  • func (x *Compressor) GetRuntimeEnabled() *v3.RuntimeFeatureFlag
  • func (*Compressor) ProtoMessage()
  • func (x *Compressor) ProtoReflect() protoreflect.Message
  • func (x *Compressor) Reset()
  • func (x *Compressor) String() string
  • func (m *Compressor) Validate() error
• type CompressorValidationError
  • func (e CompressorValidationError) Cause() error
  • func (e CompressorValidationError) Error() string
  • func (e CompressorValidationError) ErrorName() string
  • func (e CompressorValidationError) Field() string
  • func (e CompressorValidationError) Key() bool
  • func (e CompressorValidationError) Reason() string

Variables

var File_envoy_extensions_filters_http_compressor_v3_compressor_proto protoreflect.FileDescriptor

Types

type Compressor

type Compressor struct {

	// Minimum response length, in bytes, which will trigger compression. The default value is 30.
	ContentLength *wrappers.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.
	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.
	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.
	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. If not specified, defaults to enabled.
	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_api_msg_extensions.compression.gzip.compressor.v3.Gzip>`
	// is included in Envoy.
	// This field is ignored if used in the context of the gzip http-filter, but is mandatory otherwise.
	CompressorLibrary *v3.TypedExtensionConfig `protobuf:"bytes,6,opt,name=compressor_library,json=compressorLibrary,proto3" json:"compressor_library,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 7]

func (*Compressor) Descriptor

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

Deprecated: Use Compressor.ProtoReflect.Descriptor instead.

func (*Compressor) GetCompressorLibrary

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

func (*Compressor) GetContentLength

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

func (*Compressor) GetContentType

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

func (*Compressor) GetDisableOnEtagHeader

func (x *Compressor) GetDisableOnEtagHeader() bool

func (*Compressor) GetRemoveAcceptEncodingHeader

func (x *Compressor) GetRemoveAcceptEncodingHeader() bool

func (*Compressor) GetRuntimeEnabled

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

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

func (*Compressor) Validate

func (m *Compressor) Validate() error

Validate checks the field values on Compressor with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type CompressorValidationError

type CompressorValidationError struct {
	// contains filtered or unexported fields
}

CompressorValidationError is the validation error returned by Compressor.Validate if the designated constraints aren't met.

func (CompressorValidationError) Cause

func (e CompressorValidationError) Cause() error

Cause function returns cause value.

func (CompressorValidationError) Error

func (e CompressorValidationError) Error() string

Error satisfies the builtin error interface

func (CompressorValidationError) ErrorName

func (e CompressorValidationError) ErrorName() string

ErrorName returns error name.

func (CompressorValidationError) Field

func (e CompressorValidationError) Field() string

Field function returns field value.

func (CompressorValidationError) Key

func (e CompressorValidationError) Key() bool

Key function returns key value.

func (CompressorValidationError) Reason

func (e CompressorValidationError) Reason() string

Reason function returns reason value.