跳到主要内容

Configuration 配置类

概述​

Configuration 类用于保存与 ODPS Tunnel 服务通讯过程中需要的配置信息。该类继承自 GeneralConfiguration，并扩展了一些特定于 ODPS Tunnel 的配置项。

构造方法​

Configuration(Odps odps)​

public Configuration(Odps odps)

通过 Odps 对象构建 Configuration 实例。

Configuration(Builder builder)​

public Configuration(Builder builder)

通过 Builder 对象构建 Configuration 实例，Builder 类可以通过静态方法 Configuration#builder(odps) 方法构建。

示例代码​

import com.aliyun.odps.tunnel.Configuration;

Configuration configuration=Configuration.builder(odps)
    .withRetryLogger(new RetryLogger())
    .withRetryPolicy(new FlinkDefaultRetryPolicy())
    // default compress option is zlib
    .withCompressOptions(new CompressOption())
    .build();

方法​

创建 Configuration Builder​

public static Builder builder(Odps odps)

创建并返回一个新的 Builder 对象。

获取压缩选项​

public CompressOption getCompressOption()

返回当前的压缩选项。

设置压缩选项​

public void setCompressOption(CompressOption option)

设置压缩选项。 当前支持的压缩选项为 ODPS_RAW ODPS_ZLIB ODPS_SNAPPY ODPS_LZ4_FRAME ODPS_ARROW_LZ4_FRAME （仅 Arrow Tunnel 支持） ODPS_ARROW_ZSTD （仅 Arrow Tunnel 支持）

获取指定Project的Tunnel服务入口地址​

@Override
public URI getEndpoint(String projectName)throws TunnelException

返回指定Project的Tunnel服务入口地址。

与 MaxCompute Endpoint 不同，Tunnel Endpoint 由 SDK 自动获取，通常无须用户手动指定。这个方法实现了这个路由逻辑，通常无须用户调用。

获取Odps对象​

public Odps getOdps()

返回当前的 Odps 对象。

获取 Quota 名称​

public String getQuotaName()

返回当前使用的 Quota 名称。

获取标签列表​

public List<String> getTags()

返回当前的标签列表。

获取重试策略​

public TunnelRetryHandler.RetryPolicy getRetryPolicy()

返回当前的重试策略。重试策略介绍参考RetryPolicy。

获取重试日志记录器​

public RestClient.RetryLogger getRetryLogger()

返回当前的重试日志记录器。

设置 Quota 名称​

public void setQuotaName(String quotaName)

设置希望使用的 Quota 名称。

检查 Quota 名称是否可用​

public boolean availableQuotaName()

检查当前设置的 Quota 名称是否可用，实际上这个接口不会真正检查 Quota 是否存在，只会检查用户是否设置了 Quota 名称。

创建新的RestClient​

public RestClient newRestClient(String projectName)throws TunnelException

创建并返回一个新的 RestClient 对象。

转换为Builder​

public Builder toBuilder()

将当前 Configuration 对象转换为 Configuration.Builder 对象。

Builder 类​

Configuration.Builder 类用于构建 Configuration 对象。

构造方法​

private Builder(Odps odps)

通过 Odps 对象构建 Builder 实例。

方法​

设置 Quota 名称​

public Builder withQuotaName(String quotaName)

设置配额名称。

设置标签列表​

public Builder withTags(List<String> tags)

设置标签列表。

设置压缩选项​

public Builder withCompressOptions(CompressOption compressOption)

设置压缩选项。当前支持的压缩选项为 ODPS_RAW ODPS_ZLIB ODPS_SNAPPY ODPS_LZ4_FRAME ODPS_ARROW_LZ4_FRAME （仅 Arrow Tunnel 支持） ODPS_ARROW_ZSTD （仅 Arrow Tunnel 支持）

设置重试策略​

public Builder withRetryPolicy(TunnelRetryHandler.RetryPolicy retryPolicy)

设置重试策略。默认重试策略和配置方式，参考RetryPolicy。

设置重试日志记录器​

public Builder withRetryLogger(RestClient.RetryLogger retryLogger)

设置重试日志记录器。参考RetryLogger。

构建Configuration对象​

public Configuration build()

构建并返回一个 Configuration 对象。