com.alicloud.openservices.tablestore

接口 TunnelClientInterface

所有已知实现类:

TunnelClient

public interface TunnelClientInterface

方法概要

限定符和类型	方法和说明
com.alicloud.openservices.tablestore.model.tunnel.internal.CheckpointResponse	checkpoint(com.alicloud.openservices.tablestore.model.tunnel.internal.CheckpointRequest request) Advanced Interface: Not recommended for direct use.
com.alicloud.openservices.tablestore.model.tunnel.internal.ConnectTunnelResponse	connectTunnel(com.alicloud.openservices.tablestore.model.tunnel.internal.ConnectTunnelRequest request) Advanced interface: Not recommended for direct use.
CreateTunnelResponse	createTunnel(CreateTunnelRequest request) Create a Tunnel.
DeleteTunnelResponse	deleteTunnel(DeleteTunnelRequest request) Delete a Tunnel.
DescribeTunnelResponse	describeTunnel(DescribeTunnelRequest request) Get the specific information under a certain Tunnel.
com.alicloud.openservices.tablestore.model.tunnel.internal.GetCheckpointResponse	getCheckpoint(com.alicloud.openservices.tablestore.model.tunnel.internal.GetCheckpointRequest request) Advanced Interface: Not recommended for direct use.
com.alicloud.openservices.tablestore.model.tunnel.internal.HeartbeatResponse	heartbeat(com.alicloud.openservices.tablestore.model.tunnel.internal.HeartbeatRequest request) Advanced Interface: Not recommended for direct use.
ListTunnelResponse	listTunnel(ListTunnelRequest request) Get the Tunnel information for a specific table.
com.alicloud.openservices.tablestore.model.tunnel.internal.ReadRecordsResponse	readRecords(com.alicloud.openservices.tablestore.model.tunnel.internal.ReadRecordsRequest request) Advanced Interface: Not recommended for direct use.
void	shutdown() Release resources.
com.alicloud.openservices.tablestore.model.tunnel.internal.ShutdownTunnelResponse	shutdownTunnel(com.alicloud.openservices.tablestore.model.tunnel.internal.ShutdownTunnelRequest request) Advanced Interface: Not recommended for direct use.

方法详细资料

createTunnel

CreateTunnelResponse createTunnel(CreateTunnelRequest request)
                           throws TableStoreException,
                                  ClientException

Create a Tunnel.

参数:

request - Parameters required for creating a Tunnel, see CreateTunnelRequest

返回:

The result returned after creating the Tunnel, see CreateTunnelResponse

抛出:

TableStoreException - Exception returned by the TableStore service

ClientException - Invalid request response or network exception encountered

listTunnel

ListTunnelResponse listTunnel(ListTunnelRequest request)
                       throws TableStoreException,
                              ClientException

Get the Tunnel information for a specific table.

参数:

request - Parameters required to list Tunnels under a table, see ListTunnelRequest

返回:

A list of detailed Tunnel information, see ListTunnelResponse

抛出:

TableStoreException - Exception returned by the TableStore service

ClientException - Invalid request response or network exception encountered

describeTunnel

DescribeTunnelResponse describeTunnel(DescribeTunnelRequest request)
                               throws TableStoreException,
                                      ClientException

Get the specific information under a certain Tunnel.

参数:

request - Parameters required to describe the detailed information of a certain Tunnel, see DescribeTunnelRequest

返回:

Specific information under the Tunnel, including Channel information and RPO information, etc., see DescribeTunnelResponse

抛出:

TableStoreException - Exception returned by the TableStore service

ClientException - The response result of the request is invalid, or a network exception occurred

deleteTunnel

DeleteTunnelResponse deleteTunnel(DeleteTunnelRequest request)
                           throws TableStoreException,
                                  ClientException

Delete a Tunnel.

参数:

request - Parameters required to delete a Tunnel, see DeleteTunnelRequest

返回:

The result of deleting the Tunnel, see DeleteTunnelResponse

抛出:

TableStoreException - Exception returned by the TableStore service

ClientException - Invalid request response or network exception encountered

connectTunnel

com.alicloud.openservices.tablestore.model.tunnel.internal.ConnectTunnelResponse connectTunnel(com.alicloud.openservices.tablestore.model.tunnel.internal.ConnectTunnelRequest request)
                                                                                        throws TableStoreException,
                                                                                               ClientException

Advanced interface: Not recommended for direct use. If there is no special requirement, please prioritize using the TunnelWorker automated data processing framework. Assigns a client identifier (ClientId) to a specified Tunnel and can also transmit some client parameters to the Master, such as client heartbeat timeout and client type, etc.

参数:

request - Parameters required to connect to a Tunnel, see ConnectTunnelRequest for details

返回:

The result of connecting to the Tunnel, see ConnectTunnelResponse for details

抛出:

TableStoreException - Exception returned by the TableStore service

ClientException - Invalid response from the request or network exception encountered

heartbeat

com.alicloud.openservices.tablestore.model.tunnel.internal.HeartbeatResponse heartbeat(com.alicloud.openservices.tablestore.model.tunnel.internal.HeartbeatRequest request)
                                                                                throws TableStoreException,
                                                                                       ClientException

Advanced Interface: Not recommended for direct use. If there is no special requirement, please prioritize using the TunnelWorker automated data processing framework. The function of the Heartbeat operation is to (TunnelClient) maintain a heartbeat. It can also obtain consumable Channels and report some processing statuses. When the heartbeat times out, the TunnelClient is considered offline and needs to reconnect.

参数:

request - Parameters required for detecting the heartbeat, see HeartbeatRequest for details.

返回:

The result of the heartbeat detection, see HeartbeatResponse for details.

抛出:

TableStoreException - Exception returned by the TableStore service

ClientException - Invalid return result of the request or network exception encountered

shutdownTunnel

com.alicloud.openservices.tablestore.model.tunnel.internal.ShutdownTunnelResponse shutdownTunnel(com.alicloud.openservices.tablestore.model.tunnel.internal.ShutdownTunnelRequest request)
                                                                                          throws TableStoreException,
                                                                                                 ClientException

Advanced Interface: Not recommended for direct use. If there is no special requirement, please prioritize using the TunnelWorker automated data processing framework. Close a TunnelClient and disconnect from the Tunnel server.

参数:

request - Parameters required to shut down a TunnelClient, see ShutdownTunnelRequest

返回:

The result of shutting down the TunnelClient, see ShutdownTunnelResponse

抛出:

TableStoreException - Exception returned by the TableStore service

ClientException - Invalid response or network exception encountered during the request

getCheckpoint

com.alicloud.openservices.tablestore.model.tunnel.internal.GetCheckpointResponse getCheckpoint(com.alicloud.openservices.tablestore.model.tunnel.internal.GetCheckpointRequest request)
                                                                                        throws TableStoreException,
                                                                                               ClientException

Advanced Interface: Not recommended for direct use. If there is no special requirement, please prioritize using the TunnelWorker automated data processing framework. Get the Checkpoint and the SequenceNumber corresponding to the Checkpoint that was last recorded for a specific Channel.

参数:

request - Parameters required to get the Checkpoint of a specific Channel, see GetCheckpointRequest

返回:

The result of the Checkpoint last recorded for a specific Channel

抛出:

TableStoreException - Exception returned by the TableStore service

ClientException - Invalid response from the request or network exception encountered

readRecords

com.alicloud.openservices.tablestore.model.tunnel.internal.ReadRecordsResponse readRecords(com.alicloud.openservices.tablestore.model.tunnel.internal.ReadRecordsRequest request)
                                                                                    throws TableStoreException,
                                                                                           ClientException

Advanced Interface: Not recommended for direct use. If there is no special requirement, please prioritize using the TunnelWorker automated data processing framework. Read data from a specific Channel by specifying the Tunnel ID, Client ID, Channel ID, and starting Token value. During the first read, use the previously recorded Token (Checkpoint) to start reading, and subsequently use the returned NextToken to continue reading.

参数:

request - Read data from a specific Channel, see details in ReadRecordsRequest

返回:

Data from a specific Channel (either full or incremental type data)

抛出:

TableStoreException - Exception returned by the TableStore service

ClientException - Invalid response result or network exception encountered during the request

checkpoint

com.alicloud.openservices.tablestore.model.tunnel.internal.CheckpointResponse checkpoint(com.alicloud.openservices.tablestore.model.tunnel.internal.CheckpointRequest request)
                                                                                  throws TableStoreException,
                                                                                         ClientException

Advanced Interface: Not recommended for direct use. If there is no special requirement, please prioritize using the TunnelWorker automated data processing framework. Set the Checkpoint and the SequenceNumber corresponding to the Checkpoint for a specific Channel.

参数:

request - Set the Checkpoint for a specific Channel

返回:

抛出:

TableStoreException - Exception returned by the TableStore service

ClientException - The response result is invalid or a network exception occurred

shutdown

void shutdown()

Release resources.

Make sure to release resources after all requests have been executed. After releasing resources, no further requests can be sent, and ongoing requests may not return results.