AS AgentScopeAPI 手册 / API Reference

CompressionEncoding

public enum CompressionEncoding
源码Source io/agentscope/examples/compression/extra/CompressionEncoding.java:35–148

定义压缩 Encoding相关取值的枚举。位于 io.agentscope.examples.compression.extra 包。核心成员包括 getHeaderValue、fromHeaderValue、buildAcceptEncodingHeader、toString、NONE、GZIP。

Supported compression encodings for HTTP requests and responses.

This enum defines the compression algorithms that can be used for:

  • Request body compression (Content-Encoding header)

  • Response body decompression (Accept-Encoding header)

Usage example:

`CompressionConfig config = CompressionConfig.builder()
.requestCompression(CompressionEncoding.GZIP)
.acceptEncoding(CompressionEncoding.GZIP)
.build();
`

枚举常量摘要Enum Constant Summary

常量Constant说明Description
NONE
执行 `NONE` 方法。
No compression.
GZIP
执行 `GZIP` 方法。
GZIP compression (RFC 1952).
BROTLI
执行 `BROTLI` 方法。
Brotli compression (RFC 7932).
ZSTD
执行 `ZSTD` 方法。
Zstandard (Zstd) compression (RFC 8478).

方法摘要Method Summary

方法Method说明Description
public String getHeaderValue()
获取请求头值。
Get the HTTP header value for this compression encoding.
public static CompressionEncoding fromHeaderValue(String headerValue)
static
设置来自请求头值。
Parse a compression encoding from an HTTP header value.
public static String buildAcceptEncodingHeader(CompressionEncoding... encodings)
static
构建 `buildAcceptEncodingHeader`。
Build an Accept-Encoding header value with multiple encodings.
public String toString()
返回 `toString` 结果。
Returns the to string.

枚举常量详情Enum Constant Detail

NONE

NONE("identity")
staticfinal

执行 NONE 方法。

No compression.

源码Source io/agentscope/examples/compression/extra/CompressionEncoding.java:40

GZIP

GZIP("gzip")
staticfinal

执行 GZIP 方法。

GZIP compression (RFC 1952).

源码Source io/agentscope/examples/compression/extra/CompressionEncoding.java:52

BROTLI

BROTLI("br")
staticfinal

执行 BROTLI 方法。

Brotli compression (RFC 7932).

源码Source io/agentscope/examples/compression/extra/CompressionEncoding.java:63

ZSTD

ZSTD("zstd")
staticfinal

执行 ZSTD 方法。

Zstandard (Zstd) compression (RFC 8478).

源码Source io/agentscope/examples/compression/extra/CompressionEncoding.java:74

方法详情Method Detail

getHeaderValue

public String getHeaderValue()

获取请求头值。

Get the HTTP header value for this compression encoding.

返回Returns String
返回字符串结果。the HTTP header value (e.g., "gzip", "br", "zstd", "identity")
源码Source io/agentscope/examples/compression/extra/CompressionEncoding.java:89–91

fromHeaderValue

public static CompressionEncoding fromHeaderValue(String headerValue)
static

设置来自请求头值。

Parse a compression encoding from an HTTP header value.

参数Parameters
名称Name类型Type说明Description
headerValueStringHTTP 请求头值到解析。the HTTP header value to parse
返回Returns CompressionEncoding
返回CompressionEncoding。the corresponding CompressionEncoding, or NONE if not recognized
源码Source io/agentscope/examples/compression/extra/CompressionEncoding.java:102–115

buildAcceptEncodingHeader

public static String buildAcceptEncodingHeader(CompressionEncoding... encodings)
static

构建 buildAcceptEncodingHeader。

Build an Accept-Encoding header value with multiple encodings.

参数Parameters
名称Name类型Type说明Description
encodings varargsCompressionEncoding...encodings(类型 `CompressionEncoding...`)。the encodings to include
返回Returns String
Accept-Encoding 请求头值。the Accept-Encoding header value
源码Source io/agentscope/examples/compression/extra/CompressionEncoding.java:126–142

toString

public String toString()

返回 toString 结果。

Returns the to string.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/examples/compression/extra/CompressionEncoding.java:144–147
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.