envoy_extensions_filters_http_compressor_v3

package
v1.14.4 Latest Latest
Warning

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

 Go to latest Published: Jun 13, 2022 License: Apache-2.0 Imports: 21 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: Do not use.
	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.
	//
	// Deprecated: Do not use.
	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: Do not use.
	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: Do not use.
	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.
	//
	// Deprecated: Do not use.
	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"`
	// 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 */
	// contains filtered or unexported fields
}

[#next-free-field: 9]

func (*Compressor) Descriptor deprecated 

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

Deprecated: Use Compressor.ProtoReflect.Descriptor instead.

func (*Compressor) GetCompressorLibrary added in v1.7.0 

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

func (*Compressor) GetContentLength deprecated 

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

Deprecated: Do not use.

func (*Compressor) GetContentType deprecated 

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

Deprecated: Do not use.

func (*Compressor) GetDisableOnEtagHeader deprecated 

func (x *Compressor) GetDisableOnEtagHeader() bool

Deprecated: Do not use.

func (*Compressor) GetRemoveAcceptEncodingHeader deprecated 

func (x *Compressor) GetRemoveAcceptEncodingHeader() bool

Deprecated: Do not use.

func (*Compressor) GetRequestDirectionConfig added in v1.14.0 

func (x *Compressor) GetRequestDirectionConfig() *Compressor_RequestDirectionConfig

func (*Compressor) GetResponseDirectionConfig added in v1.14.0 

func (x *Compressor) GetResponseDirectionConfig() *Compressor_ResponseDirectionConfig

func (*Compressor) GetRuntimeEnabled deprecated 

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

Deprecated: Do not use.

func (*Compressor) ProtoMessage 

func (*Compressor) ProtoMessage()

func (*Compressor) ProtoReflect added in v1.7.0 

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.

type Compressor_CommonDirectionConfig added in v1.14.0 

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. 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 *wrappers.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 added in v1.14.0 

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

Deprecated: Use Compressor_CommonDirectionConfig.ProtoReflect.Descriptor instead.

func (*Compressor_CommonDirectionConfig) GetContentType added in v1.14.0 

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

func (*Compressor_CommonDirectionConfig) GetEnabled added in v1.14.0 

func (x *Compressor_CommonDirectionConfig) GetEnabled() *v3.RuntimeFeatureFlag

func (*Compressor_CommonDirectionConfig) GetMinContentLength added in v1.14.0 

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

func (*Compressor_CommonDirectionConfig) ProtoMessage added in v1.14.0 

func (*Compressor_CommonDirectionConfig) ProtoMessage()

func (*Compressor_CommonDirectionConfig) ProtoReflect added in v1.14.0 

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

func (*Compressor_CommonDirectionConfig) Reset added in v1.14.0 

func (x *Compressor_CommonDirectionConfig) Reset()

func (*Compressor_CommonDirectionConfig) String added in v1.14.0 

func (x *Compressor_CommonDirectionConfig) String() string

func (*Compressor_CommonDirectionConfig) Validate added in v1.14.0 

func (m *Compressor_CommonDirectionConfig) Validate() error

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

type Compressor_CommonDirectionConfigValidationError added in v1.14.0 

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

Compressor_CommonDirectionConfigValidationError is the validation error returned by Compressor_CommonDirectionConfig.Validate if the designated constraints aren't met.

func (Compressor_CommonDirectionConfigValidationError) Cause added in v1.14.0 

func (e Compressor_CommonDirectionConfigValidationError) Cause() error

Cause function returns cause value.

func (Compressor_CommonDirectionConfigValidationError) Error added in v1.14.0 

func (e Compressor_CommonDirectionConfigValidationError) Error() string

Error satisfies the builtin error interface

func (Compressor_CommonDirectionConfigValidationError) ErrorName added in v1.14.0 

func (e Compressor_CommonDirectionConfigValidationError) ErrorName() string

ErrorName returns error name.

func (Compressor_CommonDirectionConfigValidationError) Field added in v1.14.0 

func (e Compressor_CommonDirectionConfigValidationError) Field() string

Field function returns field value.

func (Compressor_CommonDirectionConfigValidationError) Key added in v1.14.0 

func (e Compressor_CommonDirectionConfigValidationError) Key() bool

Key function returns key value.

func (Compressor_CommonDirectionConfigValidationError) Reason added in v1.14.0 

func (e Compressor_CommonDirectionConfigValidationError) Reason() string

Reason function returns reason value.

type Compressor_RequestDirectionConfig added in v1.14.0 

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 added in v1.14.0 

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

Deprecated: Use Compressor_RequestDirectionConfig.ProtoReflect.Descriptor instead.

func (*Compressor_RequestDirectionConfig) GetCommonConfig added in v1.14.0 

func (x *Compressor_RequestDirectionConfig) GetCommonConfig() *Compressor_CommonDirectionConfig

func (*Compressor_RequestDirectionConfig) ProtoMessage added in v1.14.0 

func (*Compressor_RequestDirectionConfig) ProtoMessage()

func (*Compressor_RequestDirectionConfig) ProtoReflect added in v1.14.0 

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

func (*Compressor_RequestDirectionConfig) Reset added in v1.14.0 

func (x *Compressor_RequestDirectionConfig) Reset()

func (*Compressor_RequestDirectionConfig) String added in v1.14.0 

func (x *Compressor_RequestDirectionConfig) String() string

func (*Compressor_RequestDirectionConfig) Validate added in v1.14.0 

func (m *Compressor_RequestDirectionConfig) Validate() error

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

type Compressor_RequestDirectionConfigValidationError added in v1.14.0 

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

Compressor_RequestDirectionConfigValidationError is the validation error returned by Compressor_RequestDirectionConfig.Validate if the designated constraints aren't met.

func (Compressor_RequestDirectionConfigValidationError) Cause added in v1.14.0 

func (e Compressor_RequestDirectionConfigValidationError) Cause() error

Cause function returns cause value.

func (Compressor_RequestDirectionConfigValidationError) Error added in v1.14.0 

func (e Compressor_RequestDirectionConfigValidationError) Error() string

Error satisfies the builtin error interface

func (Compressor_RequestDirectionConfigValidationError) ErrorName added in v1.14.0 

func (e Compressor_RequestDirectionConfigValidationError) ErrorName() string

ErrorName returns error name.

func (Compressor_RequestDirectionConfigValidationError) Field added in v1.14.0 

func (e Compressor_RequestDirectionConfigValidationError) Field() string

Field function returns field value.

func (Compressor_RequestDirectionConfigValidationError) Key added in v1.14.0 

func (e Compressor_RequestDirectionConfigValidationError) Key() bool

Key function returns key value.

func (Compressor_RequestDirectionConfigValidationError) Reason added in v1.14.0 

func (e Compressor_RequestDirectionConfigValidationError) Reason() string

Reason function returns reason value.

type Compressor_ResponseDirectionConfig added in v1.14.0 

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 added in v1.14.0 

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

Deprecated: Use Compressor_ResponseDirectionConfig.ProtoReflect.Descriptor instead.

func (*Compressor_ResponseDirectionConfig) GetCommonConfig added in v1.14.0 

func (x *Compressor_ResponseDirectionConfig) GetCommonConfig() *Compressor_CommonDirectionConfig

func (*Compressor_ResponseDirectionConfig) GetDisableOnEtagHeader added in v1.14.0 

func (x *Compressor_ResponseDirectionConfig) GetDisableOnEtagHeader() bool

func (*Compressor_ResponseDirectionConfig) GetRemoveAcceptEncodingHeader added in v1.14.0 

func (x *Compressor_ResponseDirectionConfig) GetRemoveAcceptEncodingHeader() bool

func (*Compressor_ResponseDirectionConfig) ProtoMessage added in v1.14.0 

func (*Compressor_ResponseDirectionConfig) ProtoMessage()

func (*Compressor_ResponseDirectionConfig) ProtoReflect added in v1.14.0 

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

func (*Compressor_ResponseDirectionConfig) Reset added in v1.14.0 

func (x *Compressor_ResponseDirectionConfig) Reset()

func (*Compressor_ResponseDirectionConfig) String added in v1.14.0 

func (x *Compressor_ResponseDirectionConfig) String() string

func (*Compressor_ResponseDirectionConfig) Validate added in v1.14.0 

func (m *Compressor_ResponseDirectionConfig) Validate() error

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

type Compressor_ResponseDirectionConfigValidationError added in v1.14.0 

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

Compressor_ResponseDirectionConfigValidationError is the validation error returned by Compressor_ResponseDirectionConfig.Validate if the designated constraints aren't met.

func (Compressor_ResponseDirectionConfigValidationError) Cause added in v1.14.0 

func (e Compressor_ResponseDirectionConfigValidationError) Cause() error

Cause function returns cause value.

func (Compressor_ResponseDirectionConfigValidationError) Error added in v1.14.0 

func (e Compressor_ResponseDirectionConfigValidationError) Error() string

Error satisfies the builtin error interface

func (Compressor_ResponseDirectionConfigValidationError) ErrorName added in v1.14.0 

func (e Compressor_ResponseDirectionConfigValidationError) ErrorName() string

ErrorName returns error name.

func (Compressor_ResponseDirectionConfigValidationError) Field added in v1.14.0 

func (e Compressor_ResponseDirectionConfigValidationError) Field() string

Field function returns field value.

func (Compressor_ResponseDirectionConfigValidationError) Key added in v1.14.0 

func (e Compressor_ResponseDirectionConfigValidationError) Key() bool

Key function returns key value.

func (Compressor_ResponseDirectionConfigValidationError) Reason added in v1.14.0 

func (e Compressor_ResponseDirectionConfigValidationError) Reason() string

Reason function returns reason value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.