Package com.amazonaws.athena.connector.lambda.records

Class ReadRecordsRequest

java.lang.Object

com.amazonaws.athena.connector.lambda.request.FederationRequest

com.amazonaws.athena.connector.lambda.records.RecordRequest

com.amazonaws.athena.connector.lambda.records.ReadRecordsRequest

All Implemented Interfaces:

AutoCloseable

public class ReadRecordsRequest
extends RecordRequest

Represents the input of a ReadRecords operation.

Constructor Summary

Constructors

Constructor	Description
ReadRecordsRequest(FederatedIdentity identity, String catalogName, String queryId, TableName tableName, org.apache.arrow.vector.types.pojo.Schema schema, Split split, Constraints constraints, long maxBlockSize, long maxInlineBlockSize)	Constructs a new ReadRecordsRequest object.

Method Summary

Modifier and Type	Method	Description
void	close()	Frees up resources associated with the constraints Block.
boolean	equals(Object o)
Constraints	getConstraints()	Returns the constraints to apply to read records.
long	getMaxBlockSize()	Returns the maximum supported block size.
long	getMaxInlineBlockSize()	Returns the maximum block size before spilling.
org.apache.arrow.vector.types.pojo.Schema	getSchema()	Returns the schema of the table being read from.
Split	getSplit()	Returns he split being read.
TableName	getTableName()	Returns the name of the table being read from.
int	hashCode()
String	toString()

Methods inherited from class com.amazonaws.athena.connector.lambda.records.RecordRequest

getCatalogName, getQueryId, getRequestType

Methods inherited from class com.amazonaws.athena.connector.lambda.request.FederationRequest

getIdentity

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReadRecordsRequest

public ReadRecordsRequest(FederatedIdentity identity,
                          String catalogName,
                          String queryId,
                          TableName tableName,
                          org.apache.arrow.vector.types.pojo.Schema schema,
                          Split split,
                          Constraints constraints,
                          long maxBlockSize,
                          long maxInlineBlockSize)

Constructs a new ReadRecordsRequest object.

Parameters:

identity - The identity of the caller.

catalogName - The catalog name that records should be read for.

queryId - The ID of the query requesting data.

tableName - The name of the table being read from.

schema - The schema of the table being read from.

split - The split being read.

constraints - The constraints to apply to read records.

maxBlockSize - The maximum supported block size.

maxInlineBlockSize - The maximum block size before spilling.

Method Detail

getTableName

public TableName getTableName()

Returns the name of the table being read from.

Returns:

The name of the table being read from.

getSchema

public org.apache.arrow.vector.types.pojo.Schema getSchema()

Returns the schema of the table being read from.

Returns:

The schema of the table being read from.

getSplit

public Split getSplit()

Returns he split being read.

Returns:

The split being read.

getMaxInlineBlockSize

public long getMaxInlineBlockSize()

Returns the maximum block size before spilling.

Returns:

The maximum block size before spilling.

getMaxBlockSize

public long getMaxBlockSize()

Returns the maximum supported block size.

Returns:

The maximum supported block size.

getConstraints

public Constraints getConstraints()

Returns the constraints to apply to read records.

Returns:

The constraints to apply to read records.

close

public void close()
           throws Exception

Frees up resources associated with the constraints Block.

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object