AggregateUniqueRequest.Options (Kinetica Java API 7.1.10.4 API)

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

Enclosing class:

AggregateUniqueRequest
```
public static final class AggregateUniqueRequest.Options
extends Object
```
Optional parameters.
- CREATE_TEMP_TABLE: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of result_table. If result_table_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_result_table_name. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- COLLECTION_NAME: [DEPRECATED--please specify the containing schema as part of result_table and use GPUdb.createSchema(CreateSchemaRequest) to create the schema if non-existent] Name of a schema which is to contain the table specified in result_table. If the schema provided is non-existent, it will be automatically created.
- 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, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response. Not available if 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 number of records per chunk to be used for the result table. Must be used in combination with the result_table option.
- VIEW_ID: ID of view of which the result table will be a member. 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 number of records per chunk to be used for the result table.
`static String`	`COLLECTION_NAME` [DEPRECATED--please specify the containing schema as part of `result_table` and use `GPUdb.createSchema(CreateSchemaRequest)` to create the schema if non-existent] Name of a schema which is to contain the table specified in `result_table`.
`static String`	`CREATE_TEMP_TABLE` If `true`, a unique temporary table name will be generated in the sys_temp schema and used in place of `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, in [schema_name.]table_name format, using standard	`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	`static String`	`VIEW_ID` ID of view of which the result table will be a member.

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

- Field Detail
  - CREATE_TEMP_TABLE
```
public static final String CREATE_TEMP_TABLE
```
    If true, a unique temporary table name will be generated in the sys_temp schema and used in place of result_table. If result_table_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_result_table_name. 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
  - COLLECTION_NAME
```
public static final String COLLECTION_NAME
```
    [DEPRECATED--please specify the containing schema as part of result_table and use GPUdb.createSchema(CreateSchemaRequest) to create the schema if non-existent] Name of a schema which is to contain the table specified in result_table. If the schema provided is non-existent, it will be automatically created.
    
    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, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response. Not available if 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
  - 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 number of records per chunk 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
```
    ID of view of which the result table will be a member. 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

CREATE_TEMP_TABLE

TRUE

FALSE

COLLECTION_NAME

EXPRESSION

SORT_ORDER

ASCENDING

DESCENDING

RESULT_TABLE

RESULT_TABLE_PERSIST

RESULT_TABLE_FORCE_REPLICATED

RESULT_TABLE_GENERATE_PK

TTL

CHUNK_SIZE

VIEW_ID