AggregateUniqueRequest.Options (Kinetica Java API 6.2.4.0 API)

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

Enclosing class:

AggregateUniqueRequest
```
public static final class AggregateUniqueRequest.Options
extends Object
```
Optional parameters.
- COLLECTION_NAME: Name of a collection which is to contain the table specified in result_table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table. Additionally this option is invalid if tableName is a collection.
- EXPRESSION: Optional filter expression to apply to the table.
- SORT_ORDER: String indicating how the returned values should be sorted. Supported values:
  - ASCENDING
  - DESCENDING
  The default value is ASCENDING.
- RESULT_TABLE: The name of the table used to store the results. If present, no results are returned in the response. Has the same naming restrictions as tables. Not available if tableName is a collection or when columnName is an unrestricted-length string.
- RESULT_TABLE_PERSIST: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- RESULT_TABLE_GENERATE_PK: If 'true' then set a primary key for the result table. Must be used in combination with the result_table option. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- TTL: Sets the TTL of the table specified in result_table.
- CHUNK_SIZE: Indicates the chunk size to be used for the result table. Must be used in combination with the result_table option.
- VIEW_ID: view this result table is part of. The default value is ''.
The default value is an empty Map. A set of string constants for the parameter options.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ASCENDING`
`static String`	`CHUNK_SIZE` Indicates the chunk size to be used for the result table.
`static String`	`COLLECTION_NAME` Name of a collection which is to contain the table specified in `result_table`.
`static String`	`DESCENDING`
`static String`	`EXPRESSION` Optional filter expression to apply to the table.
`static String`	`FALSE`
`static String`	`RESULT_TABLE` The name of the table used to store the results.
`static String`	`RESULT_TABLE_FORCE_REPLICATED` Force the result table to be replicated (ignores any sharding).
`static String`	`RESULT_TABLE_GENERATE_PK` If 'true' then set a primary key for the result table.
`static String`	`RESULT_TABLE_PERSIST` If `true`, then the result table specified in `result_table` will be persisted and will not expire unless a `ttl` is specified.
`static String`	`SORT_ORDER` String indicating how the returned values should be sorted.
`static String`	`TRUE`
`static String`	`TTL` Sets the TTL of the table specified in `result_table`.
`static String`	`VIEW_ID` view this result table is part of.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COLLECTION_NAME
```
public static final String COLLECTION_NAME
```
    Name of a collection which is to contain the table specified in result_table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table. Additionally this option is invalid if tableName is a collection.
    
    See Also:
    
    Constant Field Values
  - EXPRESSION
```
public static final String EXPRESSION
```
    Optional filter expression to apply to the table.
    
    See Also:
    
    Constant Field Values
  - SORT_ORDER
```
public static final String SORT_ORDER
```
    String indicating how the returned values should be sorted. Supported values:
    - ASCENDING
    - DESCENDING
    The default value is ASCENDING.
    See Also:
    
    Constant Field Values
  - ASCENDING
```
public static final String ASCENDING
```
    See Also:
    
    Constant Field Values
  - DESCENDING
```
public static final String DESCENDING
```
    See Also:
    
    Constant Field Values
  - RESULT_TABLE
```
public static final String RESULT_TABLE
```
    The name of the table used to store the results. If present, no results are returned in the response. Has the same naming restrictions as tables. Not available if tableName is a collection or when columnName is an unrestricted-length string.
    
    See Also:
    
    Constant Field Values
  - RESULT_TABLE_PERSIST
```
public static final String RESULT_TABLE_PERSIST
```
    If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    See Also:
    
    Constant Field Values
  - RESULT_TABLE_FORCE_REPLICATED
```
public static final String RESULT_TABLE_FORCE_REPLICATED
```
    Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - RESULT_TABLE_GENERATE_PK
```
public static final String RESULT_TABLE_GENERATE_PK
```
    If 'true' then set a primary key for the result table. Must be used in combination with the result_table option. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - TTL
```
public static final String TTL
```
    Sets the TTL of the table specified in result_table.
    
    See Also:
    
    Constant Field Values
  - CHUNK_SIZE
```
public static final String CHUNK_SIZE
```
    Indicates the chunk size to be used for the result table. Must be used in combination with the result_table option.
    
    See Also:
    
    Constant Field Values
  - VIEW_ID
```
public static final String VIEW_ID
```
    view this result table is part of. The default value is ''.
    
    See Also:
    
    Constant Field Values

Class AggregateUniqueRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COLLECTION_NAME

EXPRESSION

SORT_ORDER

ASCENDING

DESCENDING

RESULT_TABLE

RESULT_TABLE_PERSIST

TRUE

FALSE

RESULT_TABLE_FORCE_REPLICATED

RESULT_TABLE_GENERATE_PK

TTL

CHUNK_SIZE

VIEW_ID