com.gpudb.protocol

Class GetRecordsBySeriesRequest

java.lang.Object

com.gpudb.protocol.GetRecordsBySeriesRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class GetRecordsBySeriesRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.getRecordsBySeriesRaw(GetRecordsBySeriesRequest).

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to GPUdb.getRecordsRaw(GetRecordsRequest) this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetRecordsBySeriesRequest.Encoding Specifies the encoding for returned records; either 'binary' or 'json'.

Constructor Summary

Constructors

Constructor and Description
GetRecordsBySeriesRequest() Constructs a GetRecordsBySeriesRequest object with default parameters.
GetRecordsBySeriesRequest(String tableName, String worldTableName, int offset, int limit, Map<String,String> options) Constructs a GetRecordsBySeriesRequest object with the specified parameters.
GetRecordsBySeriesRequest(String tableName, String worldTableName, int offset, int limit, String encoding, Map<String,String> options) Constructs a GetRecordsBySeriesRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getEncoding()
int	getLimit()
int	getOffset()
Map<String,String>	getOptions()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTableName()
String	getWorldTableName()
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
GetRecordsBySeriesRequest	setEncoding(String encoding)
GetRecordsBySeriesRequest	setLimit(int limit)
GetRecordsBySeriesRequest	setOffset(int offset)
GetRecordsBySeriesRequest	setOptions(Map<String,String> options)
GetRecordsBySeriesRequest	setTableName(String tableName)
GetRecordsBySeriesRequest	setWorldTableName(String worldTableName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GetRecordsBySeriesRequest

public GetRecordsBySeriesRequest()

Constructs a GetRecordsBySeriesRequest object with default parameters.

GetRecordsBySeriesRequest

public GetRecordsBySeriesRequest(String tableName,
                                 String worldTableName,
                                 int offset,
                                 int limit,
                                 Map<String,String> options)

Constructs a GetRecordsBySeriesRequest object with the specified parameters.

Parameters:

tableName - Name of the collection/table/view for which series/tracks will be fetched.

worldTableName - Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.

offset - A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.

limit - A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250.

options - Optional parameters. The default value is an empty Map.

GetRecordsBySeriesRequest

public GetRecordsBySeriesRequest(String tableName,
                                 String worldTableName,
                                 int offset,
                                 int limit,
                                 String encoding,
                                 Map<String,String> options)

Constructs a GetRecordsBySeriesRequest object with the specified parameters.

Parameters:

tableName - Name of the collection/table/view for which series/tracks will be fetched.

worldTableName - Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.

offset - A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.

limit - A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250.

encoding - Specifies the encoding for returned records; either 'binary' or 'json'. Supported values:

• BINARY
• JSON

The default value is BINARY.

options - Optional parameters. The default value is an empty Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

the schema for the class.

getTableName

public String getTableName()

Returns:

Name of the collection/table/view for which series/tracks will be fetched.

setTableName

public GetRecordsBySeriesRequest setTableName(String tableName)

Parameters:

tableName - Name of the collection/table/view for which series/tracks will be fetched.

Returns:

this to mimic the builder pattern.

getWorldTableName

public String getWorldTableName()

Returns:

Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.

setWorldTableName

public GetRecordsBySeriesRequest setWorldTableName(String worldTableName)

Parameters:

worldTableName - Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.

Returns:

this to mimic the builder pattern.

getOffset

public int getOffset()

Returns:

A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.

setOffset

public GetRecordsBySeriesRequest setOffset(int offset)

Parameters:

offset - A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.

Returns:

this to mimic the builder pattern.

getLimit

public int getLimit()

Returns:

A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250.

setLimit

public GetRecordsBySeriesRequest setLimit(int limit)

Parameters:

limit - A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250.

Returns:

this to mimic the builder pattern.

getEncoding

public String getEncoding()

Returns:

Specifies the encoding for returned records; either 'binary' or 'json'. Supported values:

• BINARY
• JSON

The default value is BINARY.

setEncoding

public GetRecordsBySeriesRequest setEncoding(String encoding)

Parameters:

encoding - Specifies the encoding for returned records; either 'binary' or 'json'. Supported values:

• BINARY
• JSON

The default value is BINARY.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters. The default value is an empty Map.

setOptions

public GetRecordsBySeriesRequest setOptions(Map<String,String> options)

Parameters:

options - Optional parameters. The default value is an empty Map.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

the schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object