GetRecordsFromCollectionRequest (Kinetica Java API 5.2.0 API)

java.lang.Object
- com.gpudb.protocol.GetRecordsFromCollectionRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class GetRecordsFromCollectionRequest
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of parameters for GPUdb.getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest).

Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as GPUdb.deleteRecords(DeleteRecordsRequest).

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation. The Raw version of this method can be used to specify the encoding scheme of the response.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GetRecordsFromCollectionRequest.Encoding` Specifies the encoding for returned records; either 'binary' or 'json'.
`static class`	`GetRecordsFromCollectionRequest.Options` return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record.

Constructor Summary

Constructors
Constructor and Description
`GetRecordsFromCollectionRequest()` Constructs a GetRecordsFromCollectionRequest object with default parameters.
`GetRecordsFromCollectionRequest(String tableName, long offset, long limit, Map<String,String> options)` Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
`GetRecordsFromCollectionRequest(String tableName, long offset, long limit, String encoding, Map<String,String> options)` Constructs a GetRecordsFromCollectionRequest object with the specified parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` The Raw version of this method can be used to specify the encoding scheme of the response.
`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()` The Raw version of this method can be used to specify the encoding scheme of the response.
`long`	`getLimit()` The Raw version of this method can be used to specify the encoding scheme of the response.
`long`	`getOffset()` The Raw version of this method can be used to specify the encoding scheme of the response.
`Map<String,String>`	`getOptions()` The Raw version of this method can be used to specify the encoding scheme of the response.
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getTableName()` The Raw version of this method can be used to specify the encoding scheme of the response.
`int`	`hashCode()` The Raw version of this method can be used to specify the encoding scheme of the response.
`void`	`put(int index, Object value)` This method supports the Avro framework and is not intended to be called directly by the user.
`GetRecordsFromCollectionRequest`	`setEncoding(String encoding)` The Raw version of this method can be used to specify the encoding scheme of the response.
`GetRecordsFromCollectionRequest`	`setLimit(long limit)` The Raw version of this method can be used to specify the encoding scheme of the response.
`GetRecordsFromCollectionRequest`	`setOffset(long offset)` The Raw version of this method can be used to specify the encoding scheme of the response.
`GetRecordsFromCollectionRequest`	`setOptions(Map<String,String> options)` The Raw version of this method can be used to specify the encoding scheme of the response.
`GetRecordsFromCollectionRequest`	`setTableName(String tableName)` The Raw version of this method can be used to specify the encoding scheme of the response.
`String`	`toString()` The Raw version of this method can be used to specify the encoding scheme of the response.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetRecordsFromCollectionRequest
```
public GetRecordsFromCollectionRequest()
```
    Constructs a GetRecordsFromCollectionRequest object with default parameters. The Raw version of this method can be used to specify the encoding scheme of the response.
  - GetRecordsFromCollectionRequest
```
public GetRecordsFromCollectionRequest(String tableName,
                                       long offset,
                                       long limit,
                                       Map<String,String> options)
```
    Constructs a GetRecordsFromCollectionRequest object with the specified parameters. The Raw version of this method can be used to specify the encoding scheme of the response.
    Parameters:
    
    tableName - Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb collection or table.
    
    offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
    options -
    
    return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: true, false.
  - GetRecordsFromCollectionRequest
```
public GetRecordsFromCollectionRequest(String tableName,
                                       long offset,
                                       long limit,
                                       String encoding,
                                       Map<String,String> options)
```
    Constructs a GetRecordsFromCollectionRequest object with the specified parameters. The Raw version of this method can be used to specify the encoding scheme of the response.
    Parameters:
    
    tableName - Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb collection or table.
    
    offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
    
    encoding - Specifies the encoding for returned records; either 'binary' or 'json'. Values: binary, json.
    options -
    
    return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: true, false.
- 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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Returns:
    
    the schema for the class.
  - getTableName
```
public String getTableName()
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Returns:
    
    Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb collection or table.
  - setTableName
```
public GetRecordsFromCollectionRequest setTableName(String tableName)
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    tableName - Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb collection or table.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOffset
```
public long getOffset()
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Returns:
    
    A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
  - setOffset
```
public GetRecordsFromCollectionRequest setOffset(long offset)
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    Returns:
    
    this to mimic the builder pattern.
  - getLimit
```
public long getLimit()
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Returns:
    
    A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
  - setLimit
```
public GetRecordsFromCollectionRequest setLimit(long limit)
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    limit - A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
    
    Returns:
    
    this to mimic the builder pattern.
  - getEncoding
```
public String getEncoding()
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Returns:
    
    Specifies the encoding for returned records; either 'binary' or 'json'. Values: binary, json.
  - setEncoding
```
public GetRecordsFromCollectionRequest setEncoding(String encoding)
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    encoding - Specifies the encoding for returned records; either 'binary' or 'json'. Values: binary, json.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    Returns:
    return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: true, false.
  - setOptions
```
public GetRecordsFromCollectionRequest setOptions(Map<String,String> options)
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    Parameters:
    options -
    
    return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: true, false.
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    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)
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Overrides:
    
    hashCode in class Object

Class GetRecordsFromCollectionRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GetRecordsFromCollectionRequest

GetRecordsFromCollectionRequest

GetRecordsFromCollectionRequest

Method Detail

getClassSchema

getTableName

setTableName

getOffset

setOffset

getLimit

setLimit

getEncoding

setEncoding

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode