com.alicloud.openservices.tablestore

类 TunnelClient

java.lang.Object

com.alicloud.openservices.tablestore.TunnelClient

所有已实现的接口:

TunnelClientInterface

public class TunnelClient
extends Object
implements TunnelClientInterface

构造器概要

构造器

构造器和说明
TunnelClient(String endpoint, CredentialsProvider credsProvider, String instanceName, ClientConfiguration config, ResourceManager resourceManager) Constructs a new TunnelClient instance using the specified TableStore Endpoint and default configurations.
TunnelClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName) Constructs a new TunnelClient instance using the specified TableStore Endpoint and default configuration.
TunnelClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, ClientConfiguration config) Constructs a new TunnelClient instance using the specified TableStore Endpoint and configuration.
TunnelClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, ClientConfiguration config, String stsToken) Constructs a new TunnelClient instance using the specified TableStore Endpoint and default configuration.
TunnelClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, ClientConfiguration config, String stsToken, ExecutorService callbackExecutor) Constructs a new TunnelClient instance using the specified TableStore Endpoint and default configuration.
TunnelClient(String endpoint, String accessKeyId, String accessKeySecret, String instanceName, String stsToken) Constructs a new TunnelClient instance using the specified TableStore Endpoint and default configuration.

方法概要

限定符和类型	方法和说明
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.
ClientConfiguration	getClientConfig() Returns the client configuration
String	getEndpoint() Returns the TableStore Endpoint being accessed.
String	getInstanceName() Returns the name of the accessed instance
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	setExtraHeaders(Map<String,String> extraHeaders)
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.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

TunnelClient

public TunnelClient(String endpoint,
                    String accessKeyId,
                    String accessKeySecret,
                    String instanceName)

Constructs a new TunnelClient instance using the specified TableStore Endpoint and default configuration.

参数:

endpoint - The endpoint of the TableStore service.

accessKeyId - The Access ID for accessing the TableStore service.

accessKeySecret - The Access Key for accessing the TableStore service.

instanceName - The instance name for accessing the TableStore service.

TunnelClient

public TunnelClient(String endpoint,
                    String accessKeyId,
                    String accessKeySecret,
                    String instanceName,
                    String stsToken)

Constructs a new TunnelClient instance using the specified TableStore Endpoint and default configuration.

参数:

endpoint - The endpoint of the TableStore service.

accessKeyId - The Access ID for accessing the TableStore service.

accessKeySecret - The Access Key for accessing the TableStore service.

instanceName - The instance name for accessing the TableStore service.

stsToken - Sts Token.

TunnelClient

public TunnelClient(String endpoint,
                    String accessKeyId,
                    String accessKeySecret,
                    String instanceName,
                    ClientConfiguration config)

Constructs a new TunnelClient instance using the specified TableStore Endpoint and configuration.

参数:

endpoint - The endpoint of the TableStore service.

accessKeyId - The Access ID for accessing the TableStore service.

accessKeySecret - The Access Key for accessing the TableStore service.

instanceName - The instance name for accessing the TableStore service.

config - The client configuration information (ClientConfiguration). If null is passed, the default configuration will be used.

TunnelClient

public TunnelClient(String endpoint,
                    String accessKeyId,
                    String accessKeySecret,
                    String instanceName,
                    ClientConfiguration config,
                    String stsToken)

Constructs a new TunnelClient instance using the specified TableStore Endpoint and default configuration.

参数:

endpoint - The endpoint of the TableStore service.

accessKeyId - The Access ID for accessing the TableStore service.

accessKeySecret - The Access Key for accessing the TableStore service.

instanceName - The instance name for accessing the TableStore service.

config - The client configuration information (ClientConfiguration). If null is passed, the default configuration will be used.

stsToken - Sts Token.

TunnelClient

public TunnelClient(String endpoint,
                    String accessKeyId,
                    String accessKeySecret,
                    String instanceName,
                    ClientConfiguration config,
                    String stsToken,
                    ExecutorService callbackExecutor)

Constructs a new TunnelClient instance using the specified TableStore Endpoint and default configuration.

参数:

endpoint - The endpoint of the TableStore service.

accessKeyId - The Access ID for accessing the TableStore service.

accessKeySecret - The Access Key for accessing the TableStore service.

instanceName - The instance name for accessing the TableStore service.

config - The client configuration information (ClientConfiguration). If null is passed, the default configuration will be used.

stsToken - Sts Token.

callbackExecutor - The thread pool for executing callbacks. Note that this thread pool will also be shut down when the client is shut down.

TunnelClient

public TunnelClient(String endpoint,
                    CredentialsProvider credsProvider,
                    String instanceName,
                    ClientConfiguration config,
                    ResourceManager resourceManager)

Constructs a new TunnelClient instance using the specified TableStore Endpoint and default configurations.

方法详细资料

setExtraHeaders

public void setExtraHeaders(Map<String,String> extraHeaders)

getEndpoint

public String getEndpoint()

Returns the TableStore Endpoint being accessed.

返回:

TableStore Endpoint.

getInstanceName

public String getInstanceName()

Returns the name of the accessed instance

返回:

instance name

getClientConfig

public ClientConfiguration getClientConfig()

Returns the client configuration

返回:

client configuration

createTunnel

public CreateTunnelResponse createTunnel(CreateTunnelRequest request)
                                  throws TableStoreException,
                                         ClientException

从接口复制的说明: TunnelClientInterface

Create a Tunnel.

指定者:

createTunnel 在接口中 TunnelClientInterface

参数:

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

public ListTunnelResponse listTunnel(ListTunnelRequest request)
                              throws TableStoreException,
                                     ClientException

从接口复制的说明: TunnelClientInterface

Get the Tunnel information for a specific table.

指定者:

listTunnel 在接口中 TunnelClientInterface

参数:

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

public DescribeTunnelResponse describeTunnel(DescribeTunnelRequest request)
                                      throws TableStoreException,
                                             ClientException

从接口复制的说明: TunnelClientInterface

Get the specific information under a certain Tunnel.

指定者:

describeTunnel 在接口中 TunnelClientInterface

参数:

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

public DeleteTunnelResponse deleteTunnel(DeleteTunnelRequest request)
                                  throws TableStoreException,
                                         ClientException

从接口复制的说明: TunnelClientInterface

Delete a Tunnel.

指定者:

deleteTunnel 在接口中 TunnelClientInterface

参数:

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

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

从接口复制的说明: TunnelClientInterface

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.

指定者:

connectTunnel 在接口中 TunnelClientInterface

参数:

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

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

从接口复制的说明: TunnelClientInterface

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.

指定者:

heartbeat 在接口中 TunnelClientInterface

参数:

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

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

从接口复制的说明: TunnelClientInterface

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.

指定者:

shutdownTunnel 在接口中 TunnelClientInterface

参数:

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

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

从接口复制的说明: TunnelClientInterface

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.

指定者:

getCheckpoint 在接口中 TunnelClientInterface

参数:

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

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

从接口复制的说明: TunnelClientInterface

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.

指定者:

readRecords 在接口中 TunnelClientInterface

参数:

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

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

从接口复制的说明: TunnelClientInterface

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.

指定者:

checkpoint 在接口中 TunnelClientInterface

参数:

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

public void shutdown()

从接口复制的说明: TunnelClientInterface

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.

指定者:

shutdown 在接口中 TunnelClientInterface