go-control-plane: github.com/envoyproxy/go-control-plane/envoy/extensions/filters/http/compressor/v3 Index | Files

package envoy_extensions_filters_http_compressor_v3

import "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/http/compressor/v3"

Index

Package Files

compressor.pb.go compressor.pb.validate.go

Variables

var File_envoy_extensions_filters_http_compressor_v3_compressor_proto protoreflect.FileDescriptor

type Compressor Uses

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 `protobuf:"varint,4,opt,name=remove_accept_encoding_header,json=removeAcceptEncodingHeader,proto3" json:"remove_accept_encoding_header,omitempty"`
    // 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 `protobuf:"bytes,7,opt,name=request_direction_config,json=requestDirectionConfig,proto3" json:"request_direction_config,omitempty"`
    // 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 `protobuf:"bytes,8,opt,name=response_direction_config,json=responseDirectionConfig,proto3" json:"response_direction_config,omitempty"`
    // contains filtered or unexported fields
}

[#next-free-field: 9]

func (*Compressor) Descriptor Uses

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

Deprecated: Use Compressor.ProtoReflect.Descriptor instead.

func (*Compressor) GetCompressorLibrary Uses

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

func (*Compressor) GetContentLength Uses

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

Deprecated: Do not use.

func (*Compressor) GetContentType Uses

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

Deprecated: Do not use.

func (*Compressor) GetDisableOnEtagHeader Uses

func (x *Compressor) GetDisableOnEtagHeader() bool

Deprecated: Do not use.

func (*Compressor) GetRemoveAcceptEncodingHeader Uses

func (x *Compressor) GetRemoveAcceptEncodingHeader() bool

Deprecated: Do not use.

func (*Compressor) GetRequestDirectionConfig Uses

func (x *Compressor) GetRequestDirectionConfig() *Compressor_RequestDirectionConfig

func (*Compressor) GetResponseDirectionConfig Uses

func (x *Compressor) GetResponseDirectionConfig() *Compressor_ResponseDirectionConfig

func (*Compressor) GetRuntimeEnabled Uses

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

Deprecated: Do not use.

func (*Compressor) ProtoMessage Uses

func (*Compressor) ProtoMessage()

func (*Compressor) ProtoReflect Uses

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

func (*Compressor) Reset Uses

func (x *Compressor) Reset()

func (*Compressor) String Uses

func (x *Compressor) String() string

func (*Compressor) Validate Uses

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 Uses

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 Uses

func (e CompressorValidationError) Cause() error

Cause function returns cause value.

func (CompressorValidationError) Error Uses

func (e CompressorValidationError) Error() string

Error satisfies the builtin error interface

func (CompressorValidationError) ErrorName Uses

func (e CompressorValidationError) ErrorName() string

ErrorName returns error name.

func (CompressorValidationError) Field Uses

func (e CompressorValidationError) Field() string

Field function returns field value.

func (CompressorValidationError) Key Uses

func (e CompressorValidationError) Key() bool

Key function returns key value.

func (CompressorValidationError) Reason Uses

func (e CompressorValidationError) Reason() string

Reason function returns reason value.

type Compressor_CommonDirectionConfig Uses

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 Uses

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

Deprecated: Use Compressor_CommonDirectionConfig.ProtoReflect.Descriptor instead.

func (*Compressor_CommonDirectionConfig) GetContentType Uses

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

func (*Compressor_CommonDirectionConfig) GetEnabled Uses

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

func (*Compressor_CommonDirectionConfig) GetMinContentLength Uses

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

func (*Compressor_CommonDirectionConfig) ProtoMessage Uses

func (*Compressor_CommonDirectionConfig) ProtoMessage()

func (*Compressor_CommonDirectionConfig) ProtoReflect Uses

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

func (*Compressor_CommonDirectionConfig) Reset Uses

func (x *Compressor_CommonDirectionConfig) Reset()

func (*Compressor_CommonDirectionConfig) String Uses

func (x *Compressor_CommonDirectionConfig) String() string

func (*Compressor_CommonDirectionConfig) Validate Uses

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 Uses

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 Uses

func (e Compressor_CommonDirectionConfigValidationError) Cause() error

Cause function returns cause value.

func (Compressor_CommonDirectionConfigValidationError) Error Uses

func (e Compressor_CommonDirectionConfigValidationError) Error() string

Error satisfies the builtin error interface

func (Compressor_CommonDirectionConfigValidationError) ErrorName Uses

func (e Compressor_CommonDirectionConfigValidationError) ErrorName() string

ErrorName returns error name.

func (Compressor_CommonDirectionConfigValidationError) Field Uses

func (e Compressor_CommonDirectionConfigValidationError) Field() string

Field function returns field value.

func (Compressor_CommonDirectionConfigValidationError) Key Uses

func (e Compressor_CommonDirectionConfigValidationError) Key() bool

Key function returns key value.

func (Compressor_CommonDirectionConfigValidationError) Reason Uses

func (e Compressor_CommonDirectionConfigValidationError) Reason() string

Reason function returns reason value.

type Compressor_RequestDirectionConfig Uses

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 Uses

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

Deprecated: Use Compressor_RequestDirectionConfig.ProtoReflect.Descriptor instead.

func (*Compressor_RequestDirectionConfig) GetCommonConfig Uses

func (x *Compressor_RequestDirectionConfig) GetCommonConfig() *Compressor_CommonDirectionConfig

func (*Compressor_RequestDirectionConfig) ProtoMessage Uses

func (*Compressor_RequestDirectionConfig) ProtoMessage()

func (*Compressor_RequestDirectionConfig) ProtoReflect Uses

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

func (*Compressor_RequestDirectionConfig) Reset Uses

func (x *Compressor_RequestDirectionConfig) Reset()

func (*Compressor_RequestDirectionConfig) String Uses

func (x *Compressor_RequestDirectionConfig) String() string

func (*Compressor_RequestDirectionConfig) Validate Uses

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 Uses

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 Uses

func (e Compressor_RequestDirectionConfigValidationError) Cause() error

Cause function returns cause value.

func (Compressor_RequestDirectionConfigValidationError) Error Uses

func (e Compressor_RequestDirectionConfigValidationError) Error() string

Error satisfies the builtin error interface

func (Compressor_RequestDirectionConfigValidationError) ErrorName Uses

func (e Compressor_RequestDirectionConfigValidationError) ErrorName() string

ErrorName returns error name.

func (Compressor_RequestDirectionConfigValidationError) Field Uses

func (e Compressor_RequestDirectionConfigValidationError) Field() string

Field function returns field value.

func (Compressor_RequestDirectionConfigValidationError) Key Uses

func (e Compressor_RequestDirectionConfigValidationError) Key() bool

Key function returns key value.

func (Compressor_RequestDirectionConfigValidationError) Reason Uses

func (e Compressor_RequestDirectionConfigValidationError) Reason() string

Reason function returns reason value.

type Compressor_ResponseDirectionConfig Uses

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 `protobuf:"varint,3,opt,name=remove_accept_encoding_header,json=removeAcceptEncodingHeader,proto3" json:"remove_accept_encoding_header,omitempty"`
    // contains filtered or unexported fields
}

Configuration for filter behavior on the response direction.

func (*Compressor_ResponseDirectionConfig) Descriptor Uses

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

Deprecated: Use Compressor_ResponseDirectionConfig.ProtoReflect.Descriptor instead.

func (*Compressor_ResponseDirectionConfig) GetCommonConfig Uses

func (x *Compressor_ResponseDirectionConfig) GetCommonConfig() *Compressor_CommonDirectionConfig

func (*Compressor_ResponseDirectionConfig) GetDisableOnEtagHeader Uses

func (x *Compressor_ResponseDirectionConfig) GetDisableOnEtagHeader() bool

func (*Compressor_ResponseDirectionConfig) GetRemoveAcceptEncodingHeader Uses

func (x *Compressor_ResponseDirectionConfig) GetRemoveAcceptEncodingHeader() bool

func (*Compressor_ResponseDirectionConfig) ProtoMessage Uses

func (*Compressor_ResponseDirectionConfig) ProtoMessage()

func (*Compressor_ResponseDirectionConfig) ProtoReflect Uses

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

func (*Compressor_ResponseDirectionConfig) Reset Uses

func (x *Compressor_ResponseDirectionConfig) Reset()

func (*Compressor_ResponseDirectionConfig) String Uses

func (x *Compressor_ResponseDirectionConfig) String() string

func (*Compressor_ResponseDirectionConfig) Validate Uses

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 Uses

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 Uses

func (e Compressor_ResponseDirectionConfigValidationError) Cause() error

Cause function returns cause value.

func (Compressor_ResponseDirectionConfigValidationError) Error Uses

func (e Compressor_ResponseDirectionConfigValidationError) Error() string

Error satisfies the builtin error interface

func (Compressor_ResponseDirectionConfigValidationError) ErrorName Uses

func (e Compressor_ResponseDirectionConfigValidationError) ErrorName() string

ErrorName returns error name.

func (Compressor_ResponseDirectionConfigValidationError) Field Uses

func (e Compressor_ResponseDirectionConfigValidationError) Field() string

Field function returns field value.

func (Compressor_ResponseDirectionConfigValidationError) Key Uses

func (e Compressor_ResponseDirectionConfigValidationError) Key() bool

Key function returns key value.

func (Compressor_ResponseDirectionConfigValidationError) Reason Uses

func (e Compressor_ResponseDirectionConfigValidationError) Reason() string

Reason function returns reason value.

Package envoy_extensions_filters_http_compressor_v3 imports 21 packages (graph) and is imported by 9 packages. Updated 2021-01-19. Refresh now. Tools for package owners.