GetRecordsFromCollectionRequest (Kinetica Java API 7.2.3.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.getRecordsFromCollection.
Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as GPUdb.deleteRecords.
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 views using this operation. (DEPRECATED)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GetRecordsFromCollectionRequest.Encoding` A set of string constants for the `GetRecordsFromCollectionRequest` parameter `encoding`.
`static class`	`GetRecordsFromCollectionRequest.Options` A set of string constants for the `GetRecordsFromCollectionRequest` parameter `options`.

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)`
`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()` Specifies the encoding for returned records; either `BINARY` or `JSON`.
`long`	`getLimit()` A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
`long`	`getOffset()` A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
`Map<String,String>`	`getOptions()` `RETURN_RECORD_IDS`: If `TRUE` then return the internal record ID along with each returned record.
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`String`	`getTableName()` Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard	`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.
`GetRecordsFromCollectionRequest`	`setEncoding(String encoding)` Specifies the encoding for returned records; either `BINARY` or `JSON`.
`GetRecordsFromCollectionRequest`	`setLimit(long limit)` A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
`GetRecordsFromCollectionRequest`	`setOffset(long offset)` A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
`GetRecordsFromCollectionRequest`	`setOptions(Map<String,String> options)` `RETURN_RECORD_IDS`: If `TRUE` then return the internal record ID along with each returned record.
`GetRecordsFromCollectionRequest`	`setTableName(String tableName)` Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard	`String`	`toString()`

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.
  - GetRecordsFromCollectionRequest
```
public GetRecordsFromCollectionRequest(String tableName,
                                       long offset,
                                       long limit,
                                       Map<String,String> options)
```
    Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
    Parameters:
    
    tableName - Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing 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 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 results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use offset & limit to request subsequent pages of results. The default value is -9999.
    options -
    
    RETURN_RECORD_IDS: If TRUE then return the internal record ID along with each returned record. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    EXPRESSION: Optional filter expression to apply to the table. The default value is ''.
    The default value is an empty Map.
  - GetRecordsFromCollectionRequest
```
public GetRecordsFromCollectionRequest(String tableName,
                                       long offset,
                                       long limit,
                                       String encoding,
                                       Map<String,String> options)
```
    Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
    Parameters:
    
    tableName - Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing 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 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 results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use offset & limit to request subsequent pages of results. The default value is -9999.
    encoding - Specifies the encoding for returned records; either BINARY or JSON. Supported values:
    
    BINARY
    JSON
    The default value is BINARY.
    options -
    
    RETURN_RECORD_IDS: If TRUE then return the internal record ID along with each returned record. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    EXPRESSION: Optional filter expression to apply to the table. The default value is ''.
    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()
```
    Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table.
    
    Returns:
    
    The current value of tableName.
  - setTableName
```
public GetRecordsFromCollectionRequest setTableName(String tableName)
```
    Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table.
    
    Parameters:
    
    tableName - The new value for tableName.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOffset
```
public long getOffset()
```
    A positive integer indicating the number of initial results to skip (this can be 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:
    
    The current value of offset.
  - setOffset
```
public GetRecordsFromCollectionRequest setOffset(long offset)
```
    A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    Parameters:
    
    offset - The new value for offset.
    
    Returns:
    
    this to mimic the builder pattern.
  - getLimit
```
public long getLimit()
```
    A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use offset & limit to request subsequent pages of results. The default value is -9999.
    
    Returns:
    
    The current value of limit.
  - setLimit
```
public GetRecordsFromCollectionRequest setLimit(long limit)
```
    A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use offset & limit to request subsequent pages of results. The default value is -9999.
    
    Parameters:
    
    limit - The new value for limit.
    
    Returns:
    
    this to mimic the builder pattern.
  - getEncoding
```
public String getEncoding()
```
    Specifies the encoding for returned records; either BINARY or JSON. Supported values:
    - BINARY
    - JSON
    The default value is BINARY.
    Returns:
    
    The current value of encoding.
  - setEncoding
```
public GetRecordsFromCollectionRequest setEncoding(String encoding)
```
    Specifies the encoding for returned records; either BINARY or JSON. Supported values:
    - BINARY
    - JSON
    The default value is BINARY.
    Parameters:
    
    encoding - The new value for encoding.
    
    Returns:
    
    this to mimic the builder pattern.
  - getOptions
```
public Map<String,String> getOptions()
```
    - RETURN_RECORD_IDS: If TRUE then return the internal record ID along with each returned record. Supported values:
      
      TRUE
      FALSE
      The default value is FALSE.
    - EXPRESSION: Optional filter expression to apply to the table. The default value is ''.
    The default value is an empty Map.
    Returns:
    
    The current value of options.
  - setOptions
```
public GetRecordsFromCollectionRequest setOptions(Map<String,String> options)
```
    - RETURN_RECORD_IDS: If TRUE then return the internal record ID along with each returned record. Supported values:
      
      TRUE
      FALSE
      The default value is FALSE.
    - EXPRESSION: Optional filter expression to apply to the table. The default value is ''.
    The default value is an empty Map.
    Parameters:
    
    options - The new value for options.
    
    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

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