com.aliyun.odps.storage.internal

Class StorageStub

java.lang.Object

com.aliyun.odps.storage.internal.StorageStub

All Implemented Interfaces:

Closeable, AutoCloseable

public class StorageStub
extends Object
implements Closeable

The internal stub for communicating with the MaxCompute Storage V2 API endpoint.

This class is responsible for translating high-level SDK calls into low-level HTTP requests, handling protocol-specific details like JSON serialization and custom binary framing.

This is an internal component and is not intended for public use.

Example usage:

 StubSettings stubSettings = StubSettings.newBuilder()
     .withEndpoint("https://service.cn-hangzhou.maxcompute.aliyun.com/api")
     .withCredentialProvider(credentialsProvider)
     .build();
 StorageStub storageStub = new StorageStub(stubSettings);
 // Use storageStub for API calls
 storageStub.close();
 

Constructor Summary

Constructors

Constructor and Description
StorageStub(StubSettings stubSettings) Constructs a new StorageStub with the provided settings.

Method Summary

Modifier and Type	Method and Description
void	abortTableWriteSession(TableIdentifier tableId, String sessionId, String routeToken)
void	close()
CloseWriteStreamResponse	closeWriteStream(TableIdentifier tableId, CloseWriteStreamRequest request, String routeToken)
void	commitTableWriteSession(TableIdentifier tableId, String sessionId, String routeToken)
CreateInstanceReadSessionResponse	createInstanceReadSession(InstanceIdentifier instanceId, CreateInstanceReadSessionRequest request)
InputStream	createInstanceReadStream(InstanceIdentifier instanceId, String sessionId, Long count, Long offset, CreateInstanceReadStreamRequest request)
CreateTableReadSessionResponse	createTableReadSession(TableIdentifier tableId, CreateTableReadSessionRequest request)
InputStream	createTableReadStream(TableIdentifier tableId, InputSplit split, CreateTableReadStreamRequest request, String routeToken)
CreateTableWriteSessionResponse	createTableWriteSession(TableIdentifier tableId, CreateTableWriteSessionRequest request)
CreateWriteStreamResponse	createTableWriteStream(TableIdentifier tableId, String sessionId, CreateWriteStreamRequest request, String routeToken)
CreateInstanceReadSessionResponse	getInstanceReadSession(InstanceIdentifier instanceId, String sessionId)
CreateTableReadSessionResponse	getTableReadSession(TableIdentifier tableId, String sessionId, boolean sessionRefresh)
GetTableWriteSessionResponse	getTableWriteSession(TableIdentifier tableId, String sessionId)
GetWriteStreamResponse	getWriteStream(GetWriteStreamRequest request, String routeToken)
InputStream	preview(TableIdentifier tableId, String partitionSpec, List<String> columns, Integer limit)
InputStream	readBlobs(List<String> blobRefs)
BlobWriteResponse	tableBatchWriteBlob(TableIdentifier tableId, String sessionId, String streamId, long streamVersion, List<BlobWriteItem> blobs)
BlobWriteResponse	tableWriteBlob(TableIdentifier tableId, String sessionId, String streamId, long streamVersion, PartitionSpec partitionValues, long columnId, InputStream data)
OutputStream	wrapForCompression(OutputStream targetStream, CompressionCodec compressionCodec) Wraps a target OutputStream with a compression layer.
HttpResponse	writeTable(TableIdentifier tableId, String sessionId, String streamId, long streamVersion, long recordCount, okhttp3.RequestBody arrowStreamBody, String routeToken, String streamingTableId, Long streamingSchemaVersion)

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageStub

public StorageStub(@NotNull
                   StubSettings stubSettings)

Constructs a new StorageStub with the provided settings.

Parameters:

stubSettings - The settings for configuring the storage stub

Method Detail

createTableWriteSession

public CreateTableWriteSessionResponse createTableWriteSession(TableIdentifier tableId,
                                                               CreateTableWriteSessionRequest request)

getTableWriteSession

public GetTableWriteSessionResponse getTableWriteSession(TableIdentifier tableId,
                                                         String sessionId)

commitTableWriteSession

public void commitTableWriteSession(TableIdentifier tableId,
                                    String sessionId,
                                    String routeToken)

abortTableWriteSession

public void abortTableWriteSession(TableIdentifier tableId,
                                   String sessionId,
                                   String routeToken)

createTableWriteStream

public CreateWriteStreamResponse createTableWriteStream(TableIdentifier tableId,
                                                        String sessionId,
                                                        CreateWriteStreamRequest request,
                                                        String routeToken)

getWriteStream

public GetWriteStreamResponse getWriteStream(GetWriteStreamRequest request,
                                             String routeToken)

writeTable

public HttpResponse writeTable(TableIdentifier tableId,
                               String sessionId,
                               String streamId,
                               long streamVersion,
                               long recordCount,
                               okhttp3.RequestBody arrowStreamBody,
                               String routeToken,
                               String streamingTableId,
                               Long streamingSchemaVersion)

closeWriteStream

public CloseWriteStreamResponse closeWriteStream(TableIdentifier tableId,
                                                 CloseWriteStreamRequest request,
                                                 String routeToken)

createTableReadSession

public CreateTableReadSessionResponse createTableReadSession(TableIdentifier tableId,
                                                             CreateTableReadSessionRequest request)

getTableReadSession

public CreateTableReadSessionResponse getTableReadSession(TableIdentifier tableId,
                                                          String sessionId,
                                                          boolean sessionRefresh)

createTableReadStream

public InputStream createTableReadStream(TableIdentifier tableId,
                                         InputSplit split,
                                         CreateTableReadStreamRequest request,
                                         String routeToken)

preview

public InputStream preview(TableIdentifier tableId,
                           String partitionSpec,
                           List<String> columns,
                           Integer limit)

createInstanceReadSession

public CreateInstanceReadSessionResponse createInstanceReadSession(InstanceIdentifier instanceId,
                                                                   CreateInstanceReadSessionRequest request)

getInstanceReadSession

public CreateInstanceReadSessionResponse getInstanceReadSession(InstanceIdentifier instanceId,
                                                                String sessionId)

createInstanceReadStream

public InputStream createInstanceReadStream(InstanceIdentifier instanceId,
                                            String sessionId,
                                            Long count,
                                            Long offset,
                                            CreateInstanceReadStreamRequest request)

tableBatchWriteBlob

public BlobWriteResponse tableBatchWriteBlob(TableIdentifier tableId,
                                             String sessionId,
                                             String streamId,
                                             long streamVersion,
                                             List<BlobWriteItem> blobs)

tableWriteBlob

public BlobWriteResponse tableWriteBlob(TableIdentifier tableId,
                                        String sessionId,
                                        String streamId,
                                        long streamVersion,
                                        PartitionSpec partitionValues,
                                        long columnId,
                                        InputStream data)

readBlobs

public InputStream readBlobs(List<String> blobRefs)

wrapForCompression

public OutputStream wrapForCompression(OutputStream targetStream,
                                       CompressionCodec compressionCodec)
                                throws IOException

Wraps a target OutputStream with a compression layer. Data written to the returned stream will be compressed before being written to the original target stream.

Parameters:

targetStream - The final destination for the compressed data.

compressionCodec - The compression algorithm to use.

Returns:

A new OutputStream that performs compression.

Throws:

IOException - If an I/O error occurs.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable