io.envoyproxy.envoy.extensions.filters.http.compressor.v3

Interface CompressorOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Compressor, Compressor.Builder

public interface CompressorOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
TypedExtensionConfig	getCompressorLibrary() A compressor library to use for compression.
TypedExtensionConfigOrBuilder	getCompressorLibraryOrBuilder() A compressor library to use for compression.
com.google.protobuf.UInt32Value	getContentLength() Deprecated.
com.google.protobuf.UInt32ValueOrBuilder	getContentLengthOrBuilder() Deprecated.
String	getContentType(int index) Deprecated.
com.google.protobuf.ByteString	getContentTypeBytes(int index) Deprecated.
int	getContentTypeCount() Deprecated.
List<String>	getContentTypeList() Deprecated.
boolean	getDisableOnEtagHeader() Deprecated.
boolean	getRemoveAcceptEncodingHeader() Deprecated.
Compressor.RequestDirectionConfig	getRequestDirectionConfig() Configuration for request compression.
Compressor.RequestDirectionConfigOrBuilder	getRequestDirectionConfigOrBuilder() Configuration for request compression.
Compressor.ResponseDirectionConfig	getResponseDirectionConfig() Configuration for response compression.
Compressor.ResponseDirectionConfigOrBuilder	getResponseDirectionConfigOrBuilder() Configuration for response compression.
RuntimeFeatureFlag	getRuntimeEnabled() Deprecated.
RuntimeFeatureFlagOrBuilder	getRuntimeEnabledOrBuilder() Deprecated.
boolean	hasCompressorLibrary() A compressor library to use for compression.
boolean	hasContentLength() Deprecated.
boolean	hasRequestDirectionConfig() Configuration for request compression.
boolean	hasResponseDirectionConfig() Configuration for response compression.
boolean	hasRuntimeEnabled() Deprecated.

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

hasContentLength

@Deprecated
boolean hasContentLength()

Deprecated.

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

.google.protobuf.UInt32Value content_length = 1 [deprecated = true];

getContentLength

@Deprecated
com.google.protobuf.UInt32Value getContentLength()

Deprecated.

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

.google.protobuf.UInt32Value content_length = 1 [deprecated = true];

getContentLengthOrBuilder

@Deprecated
com.google.protobuf.UInt32ValueOrBuilder getContentLengthOrBuilder()

Deprecated.

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

.google.protobuf.UInt32Value content_length = 1 [deprecated = true];

getContentTypeList

@Deprecated
List<String> getContentTypeList()

Deprecated.

 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.
 

repeated string content_type = 2 [deprecated = true];

getContentTypeCount

@Deprecated
int getContentTypeCount()

Deprecated.

 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.
 

repeated string content_type = 2 [deprecated = true];

getContentType

@Deprecated
String getContentType(int index)

Deprecated.

 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.
 

repeated string content_type = 2 [deprecated = true];

getContentTypeBytes

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

Deprecated.

 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.
 

repeated string content_type = 2 [deprecated = true];

getDisableOnEtagHeader

@Deprecated
boolean getDisableOnEtagHeader()

Deprecated.

 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 = 3 [deprecated = true];

getRemoveAcceptEncodingHeader

@Deprecated
boolean getRemoveAcceptEncodingHeader()

Deprecated.

 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.
 

bool remove_accept_encoding_header = 4 [deprecated = true];

hasRuntimeEnabled

@Deprecated
boolean hasRuntimeEnabled()

Deprecated.

 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.
 

.envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5 [deprecated = true];

getRuntimeEnabled

@Deprecated
RuntimeFeatureFlag getRuntimeEnabled()

Deprecated.

 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.
 

.envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5 [deprecated = true];

getRuntimeEnabledOrBuilder

@Deprecated
RuntimeFeatureFlagOrBuilder getRuntimeEnabledOrBuilder()

Deprecated.

 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.
 

.envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 5 [deprecated = true];

hasCompressorLibrary

boolean hasCompressorLibrary()

 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.
 

.envoy.config.core.v3.TypedExtensionConfig compressor_library = 6;

getCompressorLibrary

TypedExtensionConfig getCompressorLibrary()

 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.
 

.envoy.config.core.v3.TypedExtensionConfig compressor_library = 6;

getCompressorLibraryOrBuilder

TypedExtensionConfigOrBuilder getCompressorLibraryOrBuilder()

 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.
 

.envoy.config.core.v3.TypedExtensionConfig compressor_library = 6;

hasRequestDirectionConfig

boolean hasRequestDirectionConfig()

 Configuration for request compression. Compression is disabled by default if left empty.
 

.envoy.extensions.filters.http.compressor.v3.Compressor.RequestDirectionConfig request_direction_config = 7;

getRequestDirectionConfig

Compressor.RequestDirectionConfig getRequestDirectionConfig()

 Configuration for request compression. Compression is disabled by default if left empty.
 

.envoy.extensions.filters.http.compressor.v3.Compressor.RequestDirectionConfig request_direction_config = 7;

getRequestDirectionConfigOrBuilder

Compressor.RequestDirectionConfigOrBuilder getRequestDirectionConfigOrBuilder()

 Configuration for request compression. Compression is disabled by default if left empty.
 

.envoy.extensions.filters.http.compressor.v3.Compressor.RequestDirectionConfig request_direction_config = 7;

hasResponseDirectionConfig

boolean hasResponseDirectionConfig()

 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>.*`.
 

.envoy.extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig response_direction_config = 8;

getResponseDirectionConfig

Compressor.ResponseDirectionConfig getResponseDirectionConfig()

 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>.*`.
 

.envoy.extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig response_direction_config = 8;

getResponseDirectionConfigOrBuilder

Compressor.ResponseDirectionConfigOrBuilder getResponseDirectionConfigOrBuilder()

 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>.*`.
 

.envoy.extensions.filters.http.compressor.v3.Compressor.ResponseDirectionConfig response_direction_config = 8;