AggregateUniqueRequest (Kinetica Java API 5.2.0 API)

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

All Implemented Interfaces:

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

Returns all the unique values from a particular column (specified by columnName) of a particular table (specified by tableName). If columnName is a numeric column the values will be in binaryEncodedResponse. Otherwise if columnName is a string column the values will be in jsonEncodedResponse. offset and limit are used to page through the results if there are large numbers of unique values. To get the first 10 unique values sorted in descending order options would be::

{"limit":"10","sort_order":"descending"}.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation. If the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not returned in the response. 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`	`AggregateUniqueRequest.Encoding` Specifies the encoding for returned records.
`static class`	`AggregateUniqueRequest.Options` Optional parameters.

Constructor Summary

Constructors
Constructor and Description
`AggregateUniqueRequest()` Constructs an AggregateUniqueRequest object with default parameters.
`AggregateUniqueRequest(String tableName, String columnName, long offset, long limit, Map<String,String> options)` Constructs an AggregateUniqueRequest object with the specified parameters.
`AggregateUniqueRequest(String tableName, String columnName, long offset, long limit, String encoding, Map<String,String> options)` Constructs an AggregateUniqueRequest 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`	`getColumnName()` The Raw version of this method can be used to specify the encoding scheme of the response.
`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.
`AggregateUniqueRequest`	`setColumnName(String columnName)` The Raw version of this method can be used to specify the encoding scheme of the response.
`AggregateUniqueRequest`	`setEncoding(String encoding)` The Raw version of this method can be used to specify the encoding scheme of the response.
`AggregateUniqueRequest`	`setLimit(long limit)` The Raw version of this method can be used to specify the encoding scheme of the response.
`AggregateUniqueRequest`	`setOffset(long offset)` The Raw version of this method can be used to specify the encoding scheme of the response.
`AggregateUniqueRequest`	`setOptions(Map<String,String> options)` The Raw version of this method can be used to specify the encoding scheme of the response.
`AggregateUniqueRequest`	`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
  - AggregateUniqueRequest
```
public AggregateUniqueRequest()
```
    Constructs an AggregateUniqueRequest object with default parameters. The Raw version of this method can be used to specify the encoding scheme of the response.
  - AggregateUniqueRequest
```
public AggregateUniqueRequest(String tableName,
                              String columnName,
                              long offset,
                              long limit,
                              Map<String,String> options)
```
    Constructs an AggregateUniqueRequest 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 table on which the operation will be performed. Must be a valid table in GPUdb.
    
    columnName - Name of the column or an expression containing one or more column names on which the unique function would be applied.
    
    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 - Optional parameters.
    
    expression: Optional filter expression to apply to the table.
    sort_order: String indicating how the returned values should be sorted. Values: ascending, descending.
    result_table: The name of the table used to store the results. If present no results are returned in the response.
  - AggregateUniqueRequest
```
public AggregateUniqueRequest(String tableName,
                              String columnName,
                              long offset,
                              long limit,
                              String encoding,
                              Map<String,String> options)
```
    Constructs an AggregateUniqueRequest 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 table on which the operation will be performed. Must be a valid table in GPUdb.
    
    columnName - Name of the column or an expression containing one or more column names on which the unique function would be applied.
    
    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. Values: binary, json.
    options - Optional parameters.
    
    expression: Optional filter expression to apply to the table.
    sort_order: String indicating how the returned values should be sorted. Values: ascending, descending.
    result_table: The name of the table used to store the results. If present no results are returned in the response.
- 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 table on which the operation will be performed. Must be a valid table in GPUdb.
  - setTableName
```
public AggregateUniqueRequest 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 table on which the operation will be performed. Must be a valid table in GPUdb.
    
    Returns:
    
    this to mimic the builder pattern.
  - getColumnName
```
public String getColumnName()
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Returns:
    
    Name of the column or an expression containing one or more column names on which the unique function would be applied.
  - setColumnName
```
public AggregateUniqueRequest setColumnName(String columnName)
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    columnName - Name of the column or an expression containing one or more column names on which the unique function would be applied.
    
    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 AggregateUniqueRequest 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 AggregateUniqueRequest 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. Values: binary, json.
  - setEncoding
```
public AggregateUniqueRequest 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. 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:
    Optional parameters.
    
    expression: Optional filter expression to apply to the table.
    sort_order: String indicating how the returned values should be sorted. Values: ascending, descending.
    result_table: The name of the table used to store the results. If present no results are returned in the response.
  - setOptions
```
public AggregateUniqueRequest setOptions(Map<String,String> options)
```
    The Raw version of this method can be used to specify the encoding scheme of the response.
    Parameters:
    options - Optional parameters.
    
    expression: Optional filter expression to apply to the table.
    sort_order: String indicating how the returned values should be sorted. Values: ascending, descending.
    result_table: The name of the table used to store the results. If present no results are returned in the response.
    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 AggregateUniqueRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AggregateUniqueRequest

AggregateUniqueRequest

AggregateUniqueRequest

Method Detail

getClassSchema

getTableName

setTableName

getColumnName

setColumnName

getOffset

setOffset

getLimit

setLimit

getEncoding

setEncoding

getOptions

setOptions

getSchema

get

put

equals

toString

hashCode