TunnelClient (AliCloud TableStore SDK for Java 5.17.5 API)

java.lang.Object
- com.alicloud.openservices.tablestore.TunnelClient

All Implemented Interfaces:: TunnelClientInterface

public class TunnelClient
extends Object
implements TunnelClientInterface

Constructor Summary

Constructors
Constructor and Description
`TunnelClient(String endpoint, CredentialsProvider credsProvider, String instanceName, ClientConfiguration config, ResourceManager resourceManager)` 使用指定的TableStore Endpoint和默认配置构造一个新的`TunnelClient`实例。
`TunnelClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName)` 使用指定的TableStore Endpoint和默认配置构造一个新的`TunnelClient`实例。
`TunnelClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, ClientConfiguration config)` 使用指定的TableStore Endpoint和配置构造一个新的`TunnelClient`实例。
`TunnelClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, ClientConfiguration config, String stsToken)` 使用指定的TableStore Endpoint和默认配置构造一个新的`TunnelClient`实例。
`TunnelClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, ClientConfiguration config, String stsToken, ExecutorService callbackExecutor)` 使用指定的TableStore Endpoint和默认配置构造一个新的`TunnelClient`实例。
`TunnelClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, String stsToken)` 使用指定的TableStore Endpoint和默认配置构造一个新的`TunnelClient`实例。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.alicloud.openservices.tablestore.model.tunnel.internal.CheckpointResponse`	`checkpoint(com.alicloud.openservices.tablestore.model.tunnel.internal.CheckpointRequest request)` 高级接口: 不推荐直接使用，无特殊需求，请优先使用TunnelWorker自动化数据处理框架。设置某个Channel的Checkpoint和Checkpoint对应的SequenceNumber。
`com.alicloud.openservices.tablestore.model.tunnel.internal.ConnectTunnelResponse`	`connectTunnel(com.alicloud.openservices.tablestore.model.tunnel.internal.ConnectTunnelRequest request)` 高级接口: 不推荐直接使用，无特殊需求，请优先使用TunnelWorker自动化数据处理框架。为指定Tunnel分配客户端标识(ClientId), 同时可以传输一些Client的参数给Master，比如client心跳超时时间，client的类型等。
`CreateTunnelResponse`	`createTunnel(CreateTunnelRequest request)` 创建一个Tunnel。
`DeleteTunnelResponse`	`deleteTunnel(DeleteTunnelRequest request)` 删除一个Tunnel。
`DescribeTunnelResponse`	`describeTunnel(DescribeTunnelRequest request)` 获取某个Tunnel下的具体信息。
`com.alicloud.openservices.tablestore.model.tunnel.internal.GetCheckpointResponse`	`getCheckpoint(com.alicloud.openservices.tablestore.model.tunnel.internal.GetCheckpointRequest request)` 高级接口: 不推荐直接使用，无特殊需求，请优先使用TunnelWorker自动化数据处理框架。获取某个Channel上次记录的Checkpoint和Checkpoint对应的SequenceNumber。
`ClientConfiguration`	`getClientConfig()` 返回Client配置
`String`	`getEndpoint()` 返回访问的TableStore Endpoint。
`String`	`getInstanceName()` 返回访问的实例的名称
`com.alicloud.openservices.tablestore.model.tunnel.internal.HeartbeatResponse`	`heartbeat(com.alicloud.openservices.tablestore.model.tunnel.internal.HeartbeatRequest request)` 高级接口: 不推荐直接使用，无特殊需求，请优先使用TunnelWorker自动化数据处理框架。 Heartbeat操作的作用为(TunnelClient)保持心跳，同时可以获取可以消费的Channel，上报一些处理状态。当心跳超时后认为TunnelClient下线，需要重新Connect。
`ListTunnelResponse`	`listTunnel(ListTunnelRequest request)` 获取某个表下的Tunnel信息。
`com.alicloud.openservices.tablestore.model.tunnel.internal.ReadRecordsResponse`	`readRecords(com.alicloud.openservices.tablestore.model.tunnel.internal.ReadRecordsRequest request)` 高级接口: 不推荐直接使用，无特殊需求，请优先使用TunnelWorker自动化数据处理框架。从某个Channel中读取数据，读取时需要指定Tunnel ID， Client ID, Channel ID和起始Token值。第一次读取时，使用上次记录的Token(Checkpoint)开始读取，之后每次使用返回的NextToken开始读取。
`void`	`setExtraHeaders(Map<String,String> extraHeaders)`
`void`	`shutdown()` 释放资源。
`com.alicloud.openservices.tablestore.model.tunnel.internal.ShutdownTunnelResponse`	`shutdownTunnel(com.alicloud.openservices.tablestore.model.tunnel.internal.ShutdownTunnelRequest request)` 高级接口: 不推荐直接使用，无特殊需求，请优先使用TunnelWorker自动化数据处理框架。关闭某个TunnelClient, 断开与Tunnel的服务端的连接。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TunnelClient
```
public TunnelClient(String endpoint,
                    String accessKeyId,
                    String accessKeySecret,
                    String instanceName)
```
    使用指定的TableStore Endpoint和默认配置构造一个新的TunnelClient实例。
    
    Parameters:
    
    endpoint - TableStore服务的endpoint。
    
    accessKeyId - 访问TableStore服务的Access ID。
    
    accessKeySecret - 访问TableStore服务的Access Key。
    
    instanceName - 访问TableStore服务的实例名称。
  - TunnelClient
```
public TunnelClient(String endpoint,
                    String accessKeyId,
                    String accessKeySecret,
                    String instanceName,
                    String stsToken)
```
    使用指定的TableStore Endpoint和默认配置构造一个新的TunnelClient实例。
    
    Parameters:
    
    endpoint - TableStore服务的endpoint。
    
    accessKeyId - 访问TableStore服务的Access ID。
    
    accessKeySecret - 访问TableStore服务的Access Key。
    
    instanceName - 访问TableStore服务的实例名称。
    
    stsToken - Sts Token.
  - TunnelClient
```
public TunnelClient(String endpoint,
                    String accessKeyId,
                    String accessKeySecret,
                    String instanceName,
                    ClientConfiguration config)
```
    使用指定的TableStore Endpoint和配置构造一个新的TunnelClient实例。
    
    Parameters:
    
    endpoint - TableStore服务的endpoint。
    
    accessKeyId - 访问TableStore服务的Access ID。
    
    accessKeySecret - 访问TableStore服务的Access Key。
    
    instanceName - 访问TableStore服务的实例名称。
    
    config - 客户端配置信息（ClientConfiguration）。如果传入null则使用默认配置。
  - TunnelClient
```
public TunnelClient(String endpoint,
                    String accessKeyId,
                    String accessKeySecret,
                    String instanceName,
                    ClientConfiguration config,
                    String stsToken)
```
    使用指定的TableStore Endpoint和默认配置构造一个新的TunnelClient实例。
    
    Parameters:
    
    endpoint - TableStore服务的endpoint。
    
    accessKeyId - 访问TableStore服务的Access ID。
    
    accessKeySecret - 访问TableStore服务的Access Key。
    
    instanceName - 访问TableStore服务的实例名称。
    
    config - 客户端配置信息（ClientConfiguration）。如果传入null则使用默认配置。
    
    stsToken - Sts Token.
  - TunnelClient
```
public TunnelClient(String endpoint,
                    String accessKeyId,
                    String accessKeySecret,
                    String instanceName,
                    ClientConfiguration config,
                    String stsToken,
                    ExecutorService callbackExecutor)
```
    使用指定的TableStore Endpoint和默认配置构造一个新的TunnelClient实例。
    
    Parameters:
    
    endpoint - TableStore服务的endpoint。
    
    accessKeyId - 访问TableStore服务的Access ID。
    
    accessKeySecret - 访问TableStore服务的Access Key。
    
    instanceName - 访问TableStore服务的实例名称。
    
    config - 客户端配置信息（ClientConfiguration）。如果传入null则使用默认配置。
    
    stsToken - Sts Token.
    
    callbackExecutor - 执行callback的线程池，需要注意的是，client在shutdown的时候也会shutdown这个线程池。
  - TunnelClient
```
public TunnelClient(String endpoint,
                    CredentialsProvider credsProvider,
                    String instanceName,
                    ClientConfiguration config,
                    ResourceManager resourceManager)
```
    使用指定的TableStore Endpoint和默认配置构造一个新的TunnelClient实例。
- Method Detail
  - setExtraHeaders
```
public void setExtraHeaders(Map<String,String> extraHeaders)
```
  - getEndpoint
```
public String getEndpoint()
```
    返回访问的TableStore Endpoint。
    
    Returns:
    
    TableStore Endpoint。
  - getInstanceName
```
public String getInstanceName()
```
    返回访问的实例的名称
    
    Returns:
    
    instance name
  - getClientConfig
```
public ClientConfiguration getClientConfig()
```
    返回Client配置
    
    Returns:
    
    client configuration
  - createTunnel
```
public CreateTunnelResponse createTunnel(CreateTunnelRequest request)
                                  throws TableStoreException,
                                         ClientException
```
    Description copied from interface: TunnelClientInterface
    
    创建一个Tunnel。
    
    Specified by:
    
    createTunnel in interface TunnelClientInterface
    
    Parameters:
    
    request - 创建Tunnel所需的参数，详见CreateTunnelRequest
    
    Returns:
    
    创建Tunnel返回的结果, 详见CreateTunnelResponse
    
    Throws:
    
    TableStoreException - TableStore服务返回的异常
    
    ClientException - 请求的返回结果无效、或遇到网络异常
  - listTunnel
```
public ListTunnelResponse listTunnel(ListTunnelRequest request)
                              throws TableStoreException,
                                     ClientException
```
    Description copied from interface: TunnelClientInterface
    
    获取某个表下的Tunnel信息。
    
    Specified by:
    
    listTunnel in interface TunnelClientInterface
    
    Parameters:
    
    request - 列举某张表下的Tunnel所需的参数，详见ListTunnelRequest
    
    Returns:
    
    Tunnel的详细信息列表, 详见ListTunnelResponse
    
    Throws:
    
    TableStoreException - TableStore服务返回的异常
    
    ClientException - 请求的返回结果无效、或遇到网络异常
  - describeTunnel
```
public DescribeTunnelResponse describeTunnel(DescribeTunnelRequest request)
                                      throws TableStoreException,
                                             ClientException
```
    Description copied from interface: TunnelClientInterface
    
    获取某个Tunnel下的具体信息。
    
    Specified by:
    
    describeTunnel in interface TunnelClientInterface
    
    Parameters:
    
    request - 描述某个Tunnel下的详细信息所需的参数，详见DescribeTunnelRequest
    
    Returns:
    
    Tunnel下的具体信息，包括Channel信息和RPO信息等，详见DescribeTunnelResponse
    
    Throws:
    
    TableStoreException - TableStore服务返回的异常
    
    ClientException - 请求的返回结果无效、或遇到网络异常
  - deleteTunnel
```
public DeleteTunnelResponse deleteTunnel(DeleteTunnelRequest request)
                                  throws TableStoreException,
                                         ClientException
```
    Description copied from interface: TunnelClientInterface
    
    删除一个Tunnel。
    
    Specified by:
    
    deleteTunnel in interface TunnelClientInterface
    
    Parameters:
    
    request - 删除某个Tunnel所需的参数，详见DeleteTunnelRequest
    
    Returns:
    
    删除Tunnel的结果，详见DeleteTunnelResponse
    
    Throws:
    
    TableStoreException - TableStore服务返回的异常
    
    ClientException - 请求的返回结果无效、或遇到网络异常
  - connectTunnel
```
public com.alicloud.openservices.tablestore.model.tunnel.internal.ConnectTunnelResponse connectTunnel(com.alicloud.openservices.tablestore.model.tunnel.internal.ConnectTunnelRequest request)
                                                                                               throws TableStoreException,
                                                                                                      ClientException
```
    Description copied from interface: TunnelClientInterface
    
    高级接口: 不推荐直接使用，无特殊需求，请优先使用TunnelWorker自动化数据处理框架。为指定Tunnel分配客户端标识(ClientId), 同时可以传输一些Client的参数给Master，比如client心跳超时时间，client的类型等。
    
    Specified by:
    
    connectTunnel in interface TunnelClientInterface
    
    Parameters:
    
    request - 连接某个Tunnel所需的参数，详见ConnectTunnelRequest
    
    Returns:
    
    连接Tunnel的结果，详见ConnectTunnelResponse
    
    Throws:
    
    TableStoreException - TableStore服务返回的异常
    
    ClientException - 请求的返回结果无效、或遇到网络异常
  - heartbeat
```
public com.alicloud.openservices.tablestore.model.tunnel.internal.HeartbeatResponse heartbeat(com.alicloud.openservices.tablestore.model.tunnel.internal.HeartbeatRequest request)
                                                                                       throws TableStoreException,
                                                                                              ClientException
```
    Description copied from interface: TunnelClientInterface
    
    高级接口: 不推荐直接使用，无特殊需求，请优先使用TunnelWorker自动化数据处理框架。 Heartbeat操作的作用为(TunnelClient)保持心跳，同时可以获取可以消费的Channel，上报一些处理状态。当心跳超时后认为TunnelClient下线，需要重新Connect。
    
    Specified by:
    
    heartbeat in interface TunnelClientInterface
    
    Parameters:
    
    request - 探测心跳所需的参数，详见HeartbeatRequest
    
    Returns:
    
    探测心跳的结果，详见HeartbeatResponse
    
    Throws:
    
    TableStoreException - TableStore服务返回的异常
    
    ClientException - 请求的返回结果无效、或遇到网络异常
  - shutdownTunnel
```
public com.alicloud.openservices.tablestore.model.tunnel.internal.ShutdownTunnelResponse shutdownTunnel(com.alicloud.openservices.tablestore.model.tunnel.internal.ShutdownTunnelRequest request)
                                                                                                 throws TableStoreException,
                                                                                                        ClientException
```
    Description copied from interface: TunnelClientInterface
    
    高级接口: 不推荐直接使用，无特殊需求，请优先使用TunnelWorker自动化数据处理框架。关闭某个TunnelClient, 断开与Tunnel的服务端的连接。
    
    Specified by:
    
    shutdownTunnel in interface TunnelClientInterface
    
    Parameters:
    
    request - 关闭TunnelClient所需的参数，详见ShutdownTunnelRequest
    
    Returns:
    
    关闭TunnelClient的结果，详见ShutdownTunnelResponse
    
    Throws:
    
    TableStoreException - TableStore服务返回的异常
    
    ClientException - 请求的返回结果无效、或遇到网络异常
  - getCheckpoint
```
public com.alicloud.openservices.tablestore.model.tunnel.internal.GetCheckpointResponse getCheckpoint(com.alicloud.openservices.tablestore.model.tunnel.internal.GetCheckpointRequest request)
                                                                                               throws TableStoreException,
                                                                                                      ClientException
```
    Description copied from interface: TunnelClientInterface
    
    高级接口: 不推荐直接使用，无特殊需求，请优先使用TunnelWorker自动化数据处理框架。获取某个Channel上次记录的Checkpoint和Checkpoint对应的SequenceNumber。
    
    Specified by:
    
    getCheckpoint in interface TunnelClientInterface
    
    Parameters:
    
    request - 获取某个Channel的Checkpoint所需的参数，详见GetCheckpointRequest
    
    Returns:
    
    某个Channel上次记录的Checkpoint结果
    
    Throws:
    
    TableStoreException - TableStore服务返回的异常
    
    ClientException - 请求的返回结果无效、或遇到网络异常
  - readRecords
```
public com.alicloud.openservices.tablestore.model.tunnel.internal.ReadRecordsResponse readRecords(com.alicloud.openservices.tablestore.model.tunnel.internal.ReadRecordsRequest request)
                                                                                           throws TableStoreException,
                                                                                                  ClientException
```
    Description copied from interface: TunnelClientInterface
    
    高级接口: 不推荐直接使用，无特殊需求，请优先使用TunnelWorker自动化数据处理框架。从某个Channel中读取数据，读取时需要指定Tunnel ID， Client ID, Channel ID和起始Token值。第一次读取时，使用上次记录的Token(Checkpoint)开始读取，之后每次使用返回的NextToken开始读取。
    
    Specified by:
    
    readRecords in interface TunnelClientInterface
    
    Parameters:
    
    request - 读取某个Channel中的数据，详见ReadRecordsRequest
    
    Returns:
    
    某个Channel上的数据(全量或增量类型数据)
    
    Throws:
    
    TableStoreException - TableStore服务返回的异常
    
    ClientException - 请求的返回结果无效、或遇到网络异常
  - checkpoint
```
public com.alicloud.openservices.tablestore.model.tunnel.internal.CheckpointResponse checkpoint(com.alicloud.openservices.tablestore.model.tunnel.internal.CheckpointRequest request)
                                                                                         throws TableStoreException,
                                                                                                ClientException
```
    Description copied from interface: TunnelClientInterface
    
    高级接口: 不推荐直接使用，无特殊需求，请优先使用TunnelWorker自动化数据处理框架。设置某个Channel的Checkpoint和Checkpoint对应的SequenceNumber。
    
    Specified by:
    
    checkpoint in interface TunnelClientInterface
    
    Parameters:
    
    request - 设置某个Channel上的Checkpoint
    
    Returns:
    
    Throws:
    
    TableStoreException - TableStore服务返回的异常
    
    ClientException - 请求的返回结果无效、或遇到网络异常
  - shutdown
```
public void shutdown()
```
    Description copied from interface: TunnelClientInterface
    
    释放资源。
    请确保在所有请求执行完毕之后释放资源。释放资源之后将不能再发送请求，正在执行的请求可能无法返回结果。
    
    Specified by:
    
    shutdown in interface TunnelClientInterface

Class TunnelClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TunnelClient

TunnelClient

TunnelClient

TunnelClient

TunnelClient

TunnelClient

Method Detail

setExtraHeaders

getEndpoint

getInstanceName

getClientConfig

createTunnel

listTunnel

describeTunnel

deleteTunnel

connectTunnel

heartbeat

shutdownTunnel

getCheckpoint

readRecords

checkpoint

shutdown