envoy.config.filter.http.gzip.v2

Interface GzipOuterClass.GzipOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

GzipOuterClass.Gzip, GzipOuterClass.Gzip.Builder

Enclosing class:

GzipOuterClass

public static interface GzipOuterClass.GzipOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
GzipOuterClass.Gzip.CompressionLevel.Enum	getCompressionLevel() A value used for selecting the zlib compression level.
int	getCompressionLevelValue() A value used for selecting the zlib compression level.
GzipOuterClass.Gzip.CompressionStrategy	getCompressionStrategy() A value used for selecting the zlib compression strategy which is directly related to the characteristics of the content.
int	getCompressionStrategyValue() A value used for selecting the zlib compression strategy which is directly related to the characteristics of the content.
com.google.protobuf.UInt32Value	getContentLength() Minimum response length, in bytes, which will trigger compression.
com.google.protobuf.UInt32ValueOrBuilder	getContentLengthOrBuilder() Minimum response length, in bytes, which will trigger compression.
String	getContentType(int index) Set of strings that allows specifying which mime-types yield compression; e.g., application/json, text/html, etc.
com.google.protobuf.ByteString	getContentTypeBytes(int index) Set of strings that allows specifying which mime-types yield compression; e.g., application/json, text/html, etc.
int	getContentTypeCount() Set of strings that allows specifying which mime-types yield compression; e.g., application/json, text/html, etc.
List<String>	getContentTypeList() Set of strings that allows specifying which mime-types yield compression; e.g., application/json, text/html, etc.
boolean	getDisableOnEtagHeader() If true, disables compression when the response contains an etag header.
com.google.protobuf.UInt32Value	getMemoryLevel() Value from 1 to 9 that controls the amount of internal memory used by zlib.
com.google.protobuf.UInt32ValueOrBuilder	getMemoryLevelOrBuilder() Value from 1 to 9 that controls the amount of internal memory used by zlib.
boolean	getRemoveAcceptEncodingHeader() 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.
com.google.protobuf.UInt32Value	getWindowBits() Value from 9 to 15 that represents the base two logarithmic of the compressor's window size.
com.google.protobuf.UInt32ValueOrBuilder	getWindowBitsOrBuilder() Value from 9 to 15 that represents the base two logarithmic of the compressor's window size.
boolean	hasContentLength() Minimum response length, in bytes, which will trigger compression.
boolean	hasMemoryLevel() Value from 1 to 9 that controls the amount of internal memory used by zlib.
boolean	hasWindowBits() Value from 9 to 15 that represents the base two logarithmic of the compressor's window size.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasMemoryLevel

boolean hasMemoryLevel()

 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.
 

.google.protobuf.UInt32Value memory_level = 1 [(.validate.rules) = { ... }

getMemoryLevel

com.google.protobuf.UInt32Value getMemoryLevel()

 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.
 

.google.protobuf.UInt32Value memory_level = 1 [(.validate.rules) = { ... }

getMemoryLevelOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getMemoryLevelOrBuilder()

 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.
 

.google.protobuf.UInt32Value memory_level = 1 [(.validate.rules) = { ... }

hasContentLength

boolean hasContentLength()

 Minimum response length, in bytes, which will trigger compression. The default value is 30.
 

.google.protobuf.UInt32Value content_length = 2 [(.validate.rules) = { ... }

getContentLength

com.google.protobuf.UInt32Value getContentLength()

 Minimum response length, in bytes, which will trigger compression. The default value is 30.
 

.google.protobuf.UInt32Value content_length = 2 [(.validate.rules) = { ... }

getContentLengthOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getContentLengthOrBuilder()

 Minimum response length, in bytes, which will trigger compression. The default value is 30.
 

.google.protobuf.UInt32Value content_length = 2 [(.validate.rules) = { ... }

getCompressionLevelValue

int getCompressionLevelValue()

 A value used for selecting the zlib compression level. This setting will affect speed and
 amount of compression applied to the content. "BEST" provides higher compression at the cost of
 higher latency, "SPEED" provides lower compression with minimum impact on response time.
 "DEFAULT" provides an optimal result between speed and compression. This field will be set to
 "DEFAULT" if not specified.
 

.envoy.config.filter.http.gzip.v2.Gzip.CompressionLevel.Enum compression_level = 3 [(.validate.rules) = { ... }

getCompressionLevel

GzipOuterClass.Gzip.CompressionLevel.Enum getCompressionLevel()

 A value used for selecting the zlib compression level. This setting will affect speed and
 amount of compression applied to the content. "BEST" provides higher compression at the cost of
 higher latency, "SPEED" provides lower compression with minimum impact on response time.
 "DEFAULT" provides an optimal result between speed and compression. This field will be set to
 "DEFAULT" if not specified.
 

.envoy.config.filter.http.gzip.v2.Gzip.CompressionLevel.Enum compression_level = 3 [(.validate.rules) = { ... }

getCompressionStrategyValue

int getCompressionStrategyValue()

 A value used for selecting the zlib compression strategy which is directly related to the
 characteristics of the content. Most of the time "DEFAULT" will be the best choice, though
 there are situations which 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.
 

.envoy.config.filter.http.gzip.v2.Gzip.CompressionStrategy compression_strategy = 4 [(.validate.rules) = { ... }

getCompressionStrategy

GzipOuterClass.Gzip.CompressionStrategy getCompressionStrategy()

 A value used for selecting the zlib compression strategy which is directly related to the
 characteristics of the content. Most of the time "DEFAULT" will be the best choice, though
 there are situations which 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.
 

.envoy.config.filter.http.gzip.v2.Gzip.CompressionStrategy compression_strategy = 4 [(.validate.rules) = { ... }

getContentTypeList

List<String> getContentTypeList()

 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".
 

repeated string content_type = 6 [(.validate.rules) = { ... }

getContentTypeCount

int getContentTypeCount()

 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".
 

repeated string content_type = 6 [(.validate.rules) = { ... }

getContentType

String getContentType(int index)

 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".
 

repeated string content_type = 6 [(.validate.rules) = { ... }

getContentTypeBytes

com.google.protobuf.ByteString getContentTypeBytes(int index)

 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".
 

repeated string content_type = 6 [(.validate.rules) = { ... }

getDisableOnEtagHeader

boolean getDisableOnEtagHeader()

 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.
 

bool disable_on_etag_header = 7;

getRemoveAcceptEncodingHeader

boolean getRemoveAcceptEncodingHeader()

 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.
 

bool remove_accept_encoding_header = 8;

hasWindowBits

boolean hasWindowBits()

 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.
 

.google.protobuf.UInt32Value window_bits = 9 [(.validate.rules) = { ... }

getWindowBits

com.google.protobuf.UInt32Value getWindowBits()

 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.
 

.google.protobuf.UInt32Value window_bits = 9 [(.validate.rules) = { ... }

getWindowBitsOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getWindowBitsOrBuilder()

 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.
 

.google.protobuf.UInt32Value window_bits = 9 [(.validate.rules) = { ... }