envoy_extensions_compression_gzip_compressor_v3

package

v2.4.0-dev Latest Latest Go to latest Published: Aug 22, 2022 License: Apache-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/datawire/ambassador

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Gzip_CompressionStrategy_name = map[int32]string{
		0: "DEFAULT_STRATEGY",
		1: "FILTERED",
		2: "HUFFMAN_ONLY",
		3: "RLE",
		4: "FIXED",
	}
	Gzip_CompressionStrategy_value = map[string]int32{
		"DEFAULT_STRATEGY": 0,
		"FILTERED":         1,
		"HUFFMAN_ONLY":     2,
		"RLE":              3,
		"FIXED":            4,
	}
)

Enum value maps for Gzip_CompressionStrategy.

View Source

var (
	Gzip_CompressionLevel_name = map[int32]string{
		0: "DEFAULT_COMPRESSION",
		1: "BEST_SPEED",

		2: "COMPRESSION_LEVEL_2",
		3: "COMPRESSION_LEVEL_3",
		4: "COMPRESSION_LEVEL_4",
		5: "COMPRESSION_LEVEL_5",
		6: "COMPRESSION_LEVEL_6",
		7: "COMPRESSION_LEVEL_7",
		8: "COMPRESSION_LEVEL_8",
		9: "COMPRESSION_LEVEL_9",
	}
	Gzip_CompressionLevel_value = map[string]int32{
		"DEFAULT_COMPRESSION": 0,
		"BEST_SPEED":          1,
		"COMPRESSION_LEVEL_1": 1,
		"COMPRESSION_LEVEL_2": 2,
		"COMPRESSION_LEVEL_3": 3,
		"COMPRESSION_LEVEL_4": 4,
		"COMPRESSION_LEVEL_5": 5,
		"COMPRESSION_LEVEL_6": 6,
		"COMPRESSION_LEVEL_7": 7,
		"COMPRESSION_LEVEL_8": 8,
		"COMPRESSION_LEVEL_9": 9,
		"BEST_COMPRESSION":    9,
	}
)

Enum value maps for Gzip_CompressionLevel.

View Source

var File_envoy_extensions_compression_gzip_compressor_v3_gzip_proto protoreflect.FileDescriptor

Functions ¶

This section is empty.

Types ¶

type Gzip ¶

type Gzip struct {

	// Value from 1 to 9 that controls the amount of internal memory used by zlib. Higher values
	// use more memory, but are faster and produce better compression results. The default value is 5.
	MemoryLevel *wrappers.UInt32Value `protobuf:"bytes,1,opt,name=memory_level,json=memoryLevel,proto3" json:"memory_level,omitempty"`
	// A value used for selecting the zlib compression level. This setting will affect speed and
	// amount of compression applied to the content. "BEST_COMPRESSION" provides higher compression
	// at the cost of higher latency and is equal to "COMPRESSION_LEVEL_9". "BEST_SPEED" provides
	// lower compression with minimum impact on response time, the same as "COMPRESSION_LEVEL_1".
	// "DEFAULT_COMPRESSION" provides an optimal result between speed and compression. According
	// to zlib's manual this level gives the same result as "COMPRESSION_LEVEL_6".
	// This field will be set to "DEFAULT_COMPRESSION" if not specified.
	CompressionLevel Gzip_CompressionLevel `` /* 185-byte string literal not displayed */
	// A value used for selecting the zlib compression strategy which is directly related to the
	// characteristics of the content. Most of the time "DEFAULT_STRATEGY" will be the best choice,
	// which is also the default value for the parameter, though there are situations when
	// changing this parameter might produce better results. For example, run-length encoding (RLE)
	// is typically used when the content is known for having sequences which same data occurs many
	// consecutive times. For more information about each strategy, please refer to zlib manual.
	CompressionStrategy Gzip_CompressionStrategy `` /* 197-byte string literal not displayed */
	// Value from 9 to 15 that represents the base two logarithmic of the compressor's window size.
	// Larger window results in better compression at the expense of memory usage. The default is 12
	// which will produce a 4096 bytes window. For more details about this parameter, please refer to
	// zlib manual > deflateInit2.
	WindowBits *wrappers.UInt32Value `protobuf:"bytes,4,opt,name=window_bits,json=windowBits,proto3" json:"window_bits,omitempty"`
	// Value for Zlib's next output buffer. If not set, defaults to 4096.
	// See https://www.zlib.net/manual.html for more details. Also see
	// https://github.com/envoyproxy/envoy/issues/8448 for context on this filter's performance.
	ChunkSize *wrappers.UInt32Value `protobuf:"bytes,5,opt,name=chunk_size,json=chunkSize,proto3" json:"chunk_size,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 6]

func (*Gzip) Descriptor deprecated

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

Deprecated: Use Gzip.ProtoReflect.Descriptor instead.

func (*Gzip) GetChunkSize ¶

func (x *Gzip) GetChunkSize() *wrappers.UInt32Value

func (*Gzip) GetCompressionLevel ¶

func (x *Gzip) GetCompressionLevel() Gzip_CompressionLevel

func (*Gzip) GetCompressionStrategy ¶

func (x *Gzip) GetCompressionStrategy() Gzip_CompressionStrategy

func (*Gzip) GetMemoryLevel ¶

func (x *Gzip) GetMemoryLevel() *wrappers.UInt32Value

func (*Gzip) GetWindowBits ¶

func (x *Gzip) GetWindowBits() *wrappers.UInt32Value

func (*Gzip) ProtoMessage ¶

func (*Gzip) ProtoMessage()

func (*Gzip) ProtoReflect ¶

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

func (*Gzip) Reset ¶

func (x *Gzip) Reset()

func (*Gzip) String ¶

func (x *Gzip) String() string

func (*Gzip) Validate ¶

func (m *Gzip) Validate() error

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

type GzipValidationError ¶

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

GzipValidationError is the validation error returned by Gzip.Validate if the designated constraints aren't met.

func (GzipValidationError) Cause ¶

func (e GzipValidationError) Cause() error

Cause function returns cause value.

func (GzipValidationError) Error ¶

func (e GzipValidationError) Error() string

Error satisfies the builtin error interface

func (GzipValidationError) ErrorName ¶

func (e GzipValidationError) ErrorName() string

ErrorName returns error name.

func (GzipValidationError) Field ¶

func (e GzipValidationError) Field() string

Field function returns field value.

func (GzipValidationError) Key ¶

func (e GzipValidationError) Key() bool

Key function returns key value.

func (GzipValidationError) Reason ¶

func (e GzipValidationError) Reason() string

Reason function returns reason value.

type Gzip_CompressionLevel ¶

type Gzip_CompressionLevel int32

const (
	Gzip_DEFAULT_COMPRESSION Gzip_CompressionLevel = 0
	Gzip_BEST_SPEED          Gzip_CompressionLevel = 1
	Gzip_COMPRESSION_LEVEL_1 Gzip_CompressionLevel = 1
	Gzip_COMPRESSION_LEVEL_2 Gzip_CompressionLevel = 2
	Gzip_COMPRESSION_LEVEL_3 Gzip_CompressionLevel = 3
	Gzip_COMPRESSION_LEVEL_4 Gzip_CompressionLevel = 4
	Gzip_COMPRESSION_LEVEL_5 Gzip_CompressionLevel = 5
	Gzip_COMPRESSION_LEVEL_6 Gzip_CompressionLevel = 6
	Gzip_COMPRESSION_LEVEL_7 Gzip_CompressionLevel = 7
	Gzip_COMPRESSION_LEVEL_8 Gzip_CompressionLevel = 8
	Gzip_COMPRESSION_LEVEL_9 Gzip_CompressionLevel = 9
	Gzip_BEST_COMPRESSION    Gzip_CompressionLevel = 9
)

func (Gzip_CompressionLevel) Descriptor ¶

func (Gzip_CompressionLevel) Descriptor() protoreflect.EnumDescriptor

func (Gzip_CompressionLevel) Enum ¶

func (x Gzip_CompressionLevel) Enum() *Gzip_CompressionLevel

func (Gzip_CompressionLevel) EnumDescriptor deprecated

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

Deprecated: Use Gzip_CompressionLevel.Descriptor instead.

func (Gzip_CompressionLevel) Number ¶

func (x Gzip_CompressionLevel) Number() protoreflect.EnumNumber

func (Gzip_CompressionLevel) String ¶

func (x Gzip_CompressionLevel) String() string

func (Gzip_CompressionLevel) Type ¶

func (Gzip_CompressionLevel) Type() protoreflect.EnumType

type Gzip_CompressionStrategy ¶

type Gzip_CompressionStrategy int32

All the values of this enumeration translate directly to zlib's compression strategies. For more information about each strategy, please refer to zlib manual.

const (
	Gzip_DEFAULT_STRATEGY Gzip_CompressionStrategy = 0
	Gzip_FILTERED         Gzip_CompressionStrategy = 1
	Gzip_HUFFMAN_ONLY     Gzip_CompressionStrategy = 2
	Gzip_RLE              Gzip_CompressionStrategy = 3
	Gzip_FIXED            Gzip_CompressionStrategy = 4
)

func (Gzip_CompressionStrategy) Descriptor ¶

func (Gzip_CompressionStrategy) Descriptor() protoreflect.EnumDescriptor

func (Gzip_CompressionStrategy) Enum ¶

func (x Gzip_CompressionStrategy) Enum() *Gzip_CompressionStrategy

func (Gzip_CompressionStrategy) EnumDescriptor deprecated

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

Deprecated: Use Gzip_CompressionStrategy.Descriptor instead.

func (Gzip_CompressionStrategy) Number ¶

func (x Gzip_CompressionStrategy) Number() protoreflect.EnumNumber

func (Gzip_CompressionStrategy) String ¶

func (x Gzip_CompressionStrategy) String() string

func (Gzip_CompressionStrategy) Type ¶

func (Gzip_CompressionStrategy) Type() protoreflect.EnumType

Source Files ¶

View all Source files

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