CreateGraphRequest.Options (Kinetica Java API 7.0.19.0 API)

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

Enclosing class:

CreateGraphRequest
```
public static final class CreateGraphRequest.Options
extends Object
```
Optional parameters.
- RESTRICTION_THRESHOLD_VALUE: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the graph.
- MERGE_TOLERANCE: If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. If nodes are within the tolerance of each other, they will be merged as a single node. The default value is '1.0E-4'.
- MIN_X: Minimum x (longitude) value for spatial graph associations. The default value is '-180.0'.
- MAX_X: Maximum x (longitude) value for spatial graph associations. The default value is '180.0'.
- MIN_Y: Minimum y (latitude) value for spatial graph associations. The default value is '-90.0'.
- MAX_Y: Maximum y (latitude) value for spatial graph associations. The default value is '90.0'.
- RECREATE: If set to true and the graph (using graphName) already exists, the graph is deleted and recreated. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- MODIFY: If set to true, recreate is set to true, and the graph (specified using graphName) already exists, the graph is updated with the given components. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- EXPORT_CREATE_RESULTS: If set to true, returns the graph topology in the response as arrays. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- ENABLE_GRAPH_DRAW: If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- SAVE_PERSIST: If set to true, the graph will be saved in the persist directory (see the config reference for more information). If set to false, the graph will be removed when the graph server is shutdown. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- SYNC_DB: If set to true and save_persist is set to true, the graph will be fully reconstructed upon a database restart and be updated to align with any source table(s) updates made since the creation of the graph. If dynamic graph updates upon table inserts are desired, use add_table_monitor instead. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- ADD_TABLE_MONITOR: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if save_persist is also set to true, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see GPUdb.createTableMonitor(CreateTableMonitorRequest). Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- GRAPH_TABLE: If specified, the created graph is also created as a table with the given name and following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
- REMOVE_LABEL_ONLY: When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity. Otherwise (default), it'll delete the label AND the entity. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- ADD_TURNS: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- TURN_ANGLE: Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. It is the vertical deviation angle from the incoming edge to the intersection node. The larger the value, the larger the threshold for sharp turns and intersections; the smaller the value, the larger the threshold for right and left turns; 0 < turn_angle < 90. The default value is '60'.
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`	`ADD_TABLE_MONITOR` Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s).
`static String`	`ADD_TURNS` Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints.
`static String`	`ENABLE_GRAPH_DRAW` If set to `true`, adds a 'EDGE_WKTLINE' column identifier to the specified `graph_table` so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed.
`static String`	`EXPORT_CREATE_RESULTS` If set to `true`, returns the graph topology in the response as arrays.
`static String`	`FALSE`
`static String`	`GRAPH_TABLE` If specified, the created graph is also created as a table with the given name and following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'.
`static String`	`MAX_X` Maximum x (longitude) value for spatial graph associations.
`static String`	`MAX_Y` Maximum y (latitude) value for spatial graph associations.
`static String`	`MERGE_TOLERANCE` If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes.
`static String`	`MIN_X` Minimum x (longitude) value for spatial graph associations.
`static String`	`MIN_Y` Minimum y (latitude) value for spatial graph associations.
`static String`	`MODIFY` If set to `true`, `recreate` is set to `true`, and the graph (specified using `graphName`) already exists, the graph is updated with the given components.
`static String`	`RECREATE` If set to `true` and the graph (using `graphName`) already exists, the graph is deleted and recreated.
`static String`	`REMOVE_LABEL_ONLY` When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity.
`static String`	`RESTRICTION_THRESHOLD_VALUE` Value-based restriction comparison.
`static String`	`SAVE_PERSIST` If set to `true`, the graph will be saved in the persist directory (see the config reference for more information).
`static String`	`SYNC_DB` If set to `true` and `save_persist` is set to `true`, the graph will be fully reconstructed upon a database restart and be updated to align with any source table(s) updates made since the creation of the graph.
`static String`	`TRUE`
`static String`	`TURN_ANGLE` Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections.

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

- Field Detail
  - RESTRICTION_THRESHOLD_VALUE
```
public static final String RESTRICTION_THRESHOLD_VALUE
```
    Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the graph.
    
    See Also:
    
    Constant Field Values
  - MERGE_TOLERANCE
```
public static final String MERGE_TOLERANCE
```
    If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. If nodes are within the tolerance of each other, they will be merged as a single node. The default value is '1.0E-4'.
    
    See Also:
    
    Constant Field Values
  - MIN_X
```
public static final String MIN_X
```
    Minimum x (longitude) value for spatial graph associations. The default value is '-180.0'.
    
    See Also:
    
    Constant Field Values
  - MAX_X
```
public static final String MAX_X
```
    Maximum x (longitude) value for spatial graph associations. The default value is '180.0'.
    
    See Also:
    
    Constant Field Values
  - MIN_Y
```
public static final String MIN_Y
```
    Minimum y (latitude) value for spatial graph associations. The default value is '-90.0'.
    
    See Also:
    
    Constant Field Values
  - MAX_Y
```
public static final String MAX_Y
```
    Maximum y (latitude) value for spatial graph associations. The default value is '90.0'.
    
    See Also:
    
    Constant Field Values
  - RECREATE
```
public static final String RECREATE
```
    If set to true and the graph (using graphName) already exists, the graph is deleted and recreated. 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
  - MODIFY
```
public static final String MODIFY
```
    If set to true, recreate is set to true, and the graph (specified using graphName) already exists, the graph is updated with the given components. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - EXPORT_CREATE_RESULTS
```
public static final String EXPORT_CREATE_RESULTS
```
    If set to true, returns the graph topology in the response as arrays. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - ENABLE_GRAPH_DRAW
```
public static final String ENABLE_GRAPH_DRAW
```
    If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - SAVE_PERSIST
```
public static final String SAVE_PERSIST
```
    If set to true, the graph will be saved in the persist directory (see the config reference for more information). If set to false, the graph will be removed when the graph server is shutdown. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - SYNC_DB
```
public static final String SYNC_DB
```
    If set to true and save_persist is set to true, the graph will be fully reconstructed upon a database restart and be updated to align with any source table(s) updates made since the creation of the graph. If dynamic graph updates upon table inserts are desired, use add_table_monitor instead. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - ADD_TABLE_MONITOR
```
public static final String ADD_TABLE_MONITOR
```
    Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if save_persist is also set to true, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see GPUdb.createTableMonitor(CreateTableMonitorRequest). Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - GRAPH_TABLE
```
public static final String GRAPH_TABLE
```
    If specified, the created graph is also created as a table with the given name and following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
    
    See Also:
    
    Constant Field Values
  - REMOVE_LABEL_ONLY
```
public static final String REMOVE_LABEL_ONLY
```
    When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity. Otherwise (default), it'll delete the label AND the entity. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - ADD_TURNS
```
public static final String ADD_TURNS
```
    Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - TURN_ANGLE
```
public static final String TURN_ANGLE
```
    Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. It is the vertical deviation angle from the incoming edge to the intersection node. The larger the value, the larger the threshold for sharp turns and intersections; the smaller the value, the larger the threshold for right and left turns; 0 < turn_angle < 90. The default value is '60'.
    
    See Also:
    
    Constant Field Values

Class CreateGraphRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RESTRICTION_THRESHOLD_VALUE

MERGE_TOLERANCE

MIN_X

MAX_X

MIN_Y

MAX_Y

RECREATE

TRUE

FALSE

MODIFY

EXPORT_CREATE_RESULTS

ENABLE_GRAPH_DRAW

SAVE_PERSIST

SYNC_DB

ADD_TABLE_MONITOR

GRAPH_TABLE

REMOVE_LABEL_ONLY

ADD_TURNS

TURN_ANGLE