java.lang.Object
- java.lang.Enum<PartitionedGraphConfig.Field>
- - oracle.pgx.config.PartitionedGraphConfig.Field

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PartitionedGraphConfig.Field>, ConfigField

Enclosing class:

PartitionedGraphConfig
```
public static enum PartitionedGraphConfig.Field
extends java.lang.Enum<PartitionedGraphConfig.Field>
implements ConfigField
```
Fields of PGX Engine Partitioned Graph Config

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ARRAY_COMPACTION_THRESHOLD`	[only relevant if the graph is optimized for updates] threshold used to determined when to compact the delta-logs into a new array.
`ATTRIBUTES`	additional attributes needed to read/write the graph data
`DATA_SOURCE_ID`	data source id to use to connect to an RDBMS instance
`EDGE_ID_STRATEGY`	Indicates what ID strategy should be used for the edges of this graph.
`EDGE_ID_TYPE`	type of the edge ID.
`EDGE_PROVIDERS`	list of edge providers in this graph
`ERROR_HANDLING`	error handling configuration
`ES_INDEX_NAME`	Index name on the Elasticsearch server form which graph data is loaded
`ES_URL`	Elasticsearch URL pointing to an Elasticsearch instance
`EXTERNAL_STORES`	Specification of the external stores where external string properties reside.
`JDBC_URL`	jdbc URL pointing to an RDBMS instance
`KEYSTORE_ALIAS`	alias to the keystore to use when connecting to database
`LOADING`	loading-specific configuration
`LOCAL_DATE_FORMAT`	array of local_date formats to use when loading and storing local_date properties.
`MAX_BATCH_SIZE`	maximal batch size of Elasticsearch response objects
`MAX_PREFETCHED_ROWS`	maximum number of rows prefetched during each round trip resultset-database
`NAME`	name of the graph
`NUM_CONNECTIONS`	number of connections to read/write data from/to the RDBMS table.
`OPTIMIZED_FOR`	Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
`PASSWORD`	password to use when connecting to database
`POINT2D`	longitude and latitude as floating point values separated by a space
`PREPARED_QUERIES`	An additional list of prepared queries with arguments, working in the same way as 'queries'.
`PROXY_URL`	proxy server URL to be used for connection to es_url
`QUERIES`	A list of queries used to determine which data to load from the database.
`REDACTION_RULES`	array of redaction rules
`RULES_MAPPING`	mapping for redaction rules to users/roles
`SCHEMA`	schema to use when reading/writing RDBMS objects
`SCROLL_TIME`	time to keep Elasticsearch-scroll alive, batch data needs to be received and processed in that time window.
`SOURCE_NAME`	name of the database graph, if the graph is loaded from a database
`SOURCE_TYPE`	source type for database graphs
`TIME_FORMAT`	the time format to use when loading and storing time properties.
`TIME_WITH_TIMEZONE_FORMAT`	the time with timezone format to use when loading and storing time with timezone properties.
`TIMESTAMP_FORMAT`	the timestamp format to use when loading and storing timestamp properties.
`TIMESTAMP_WITH_TIMEZONE_FORMAT`	the timestamp with timezone format to use when loading and storing timestamp with timezone properties.
`USERNAME`	username to use when connecting to an RDBMS instance
`VECTOR_COMPONENT_DELIMITER`	delimiter for the different components of vector properties
`VERTEX_ID_STRATEGY`	Indicates what ID strategy should be used for the vertices of this graph.
`VERTEX_ID_TYPE`	type of the vertex ID.
`VERTEX_PROVIDERS`	list of vertex providers in this graph

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Object`	`getDefaultVal()`	Gets the default value of this field.
`java.util.List<java.lang.String>`	`getKeyAliases()`	Gets the key aliases of this field which are also recognized during parsing.
`java.util.List<java.lang.String>`	`getSingletonListKeyAliases()`	Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
`java.lang.Class<?>`	`getType()`	Gets the type of this field.
`boolean`	`isArray()`	Checks if this field is an array.
`boolean`	`isHidden()`	Checks if this field should be hidden.
`boolean`	`isPath()`	Checks if this field is a path.
`boolean`	`isRequired()`	Checks if this field is required.
`boolean`	`isSensitive()`	Checks if this field holds a sensitive data.
`java.lang.String`	`toKey()`	Get the key of this field, which is how this field is represented in serialized form.
`java.lang.String`	`toString()`
`static PartitionedGraphConfig.Field`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static PartitionedGraphConfig.Field[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.pgx.config.ConfigField
isEnum, isPrimitive

- Enum Constant Detail
  - NAME
```
public static final PartitionedGraphConfig.Field NAME
```
    name of the graph
  - QUERIES
```
public static final PartitionedGraphConfig.Field QUERIES
```
    A list of queries used to determine which data to load from the database. Data matching at least one of the queries will be loaded. Not setting any query will load the entire graph.
  - PREPARED_QUERIES
```
public static final PartitionedGraphConfig.Field PREPARED_QUERIES
```
    An additional list of prepared queries with arguments, working in the same way as 'queries'. Data matching at least one those queries will also be loaded.
  - OPTIMIZED_FOR
```
public static final PartitionedGraphConfig.Field OPTIMIZED_FOR
```
    Indicates if the graph should use data-structures optimized for read-intensive scenarios or for fast updates
  - VERTEX_ID_STRATEGY
```
public static final PartitionedGraphConfig.Field VERTEX_ID_STRATEGY
```
    Indicates what ID strategy should be used for the vertices of this graph. If not specified (or set to null), the strategy will be determined during loading or using a default value
  - EDGE_ID_STRATEGY
```
public static final PartitionedGraphConfig.Field EDGE_ID_STRATEGY
```
    Indicates what ID strategy should be used for the edges of this graph. If not specified (or set to null), the strategy will be determined during loading or using a default value
  - VERTEX_ID_TYPE
```
public static final PartitionedGraphConfig.Field VERTEX_ID_TYPE
```
    type of the vertex ID. For partitioned graphs, setting it to a specific type requires the IDs in the vertex providers to be unique across the graphs; those IDs will be used as global IDs; setting it to null (or omitting it) will allow repeated IDs across different vertex providers and PGX will automatically generate globally-unique 'partitioned' IDs for the vertices
  - EDGE_ID_TYPE
```
public static final PartitionedGraphConfig.Field EDGE_ID_TYPE
```
    type of the edge ID. For partitioned graphs, setting it to long requires the IDs in the edge providers to be unique across the graphs; those IDs will be used as global IDs; setting it to null (or omitting it) will allow repeated IDs across different edge providers and PGX will automatically generate globally-unique 'partitioned' IDs for the edges
  - ARRAY_COMPACTION_THRESHOLD
```
public static final PartitionedGraphConfig.Field ARRAY_COMPACTION_THRESHOLD
```
    [only relevant if the graph is optimized for updates] threshold used to determined when to compact the delta-logs into a new array. If lower than the engine min_array_compaction_threshold value, min_array_compaction_threshold will be used instead
  - VERTEX_PROVIDERS
```
public static final PartitionedGraphConfig.Field VERTEX_PROVIDERS
```
    list of vertex providers in this graph
  - EDGE_PROVIDERS
```
public static final PartitionedGraphConfig.Field EDGE_PROVIDERS
```
    list of edge providers in this graph
  - LOADING
```
public static final PartitionedGraphConfig.Field LOADING
```
    loading-specific configuration
  - REDACTION_RULES
```
public static final PartitionedGraphConfig.Field REDACTION_RULES
```
    array of redaction rules
  - RULES_MAPPING
```
public static final PartitionedGraphConfig.Field RULES_MAPPING
```
    mapping for redaction rules to users/roles
  - EXTERNAL_STORES
```
public static final PartitionedGraphConfig.Field EXTERNAL_STORES
```
    Specification of the external stores where external string properties reside.
  - SOURCE_NAME
```
public static final PartitionedGraphConfig.Field SOURCE_NAME
```
    name of the database graph, if the graph is loaded from a database
  - SOURCE_TYPE
```
public static final PartitionedGraphConfig.Field SOURCE_TYPE
```
    source type for database graphs
  - MAX_BATCH_SIZE
```
public static final PartitionedGraphConfig.Field MAX_BATCH_SIZE
```
    maximal batch size of Elasticsearch response objects
  - ES_URL
```
public static final PartitionedGraphConfig.Field ES_URL
```
    Elasticsearch URL pointing to an Elasticsearch instance
  - ES_INDEX_NAME
```
public static final PartitionedGraphConfig.Field ES_INDEX_NAME
```
    Index name on the Elasticsearch server form which graph data is loaded
  - PROXY_URL
```
public static final PartitionedGraphConfig.Field PROXY_URL
```
    proxy server URL to be used for connection to es_url
  - SCROLL_TIME
```
public static final PartitionedGraphConfig.Field SCROLL_TIME
```
    time to keep Elasticsearch-scroll alive, batch data needs to be received and processed in that time window. Follows time unit format: [number][time unit] where time unit is d for day, h for hour m for minute etc.
  - USERNAME
```
public static final PartitionedGraphConfig.Field USERNAME
```
    username to use when connecting to an RDBMS instance
  - NUM_CONNECTIONS
```
public static final PartitionedGraphConfig.Field NUM_CONNECTIONS
```
    number of connections to read/write data from/to the RDBMS table. For the distributed runtime, this value will be multiplied by the number of machines used
  - SCHEMA
```
public static final PartitionedGraphConfig.Field SCHEMA
```
    schema to use when reading/writing RDBMS objects
  - JDBC_URL
```
public static final PartitionedGraphConfig.Field JDBC_URL
```
    jdbc URL pointing to an RDBMS instance
  - DATA_SOURCE_ID
```
public static final PartitionedGraphConfig.Field DATA_SOURCE_ID
```
    data source id to use to connect to an RDBMS instance
  - MAX_PREFETCHED_ROWS
```
public static final PartitionedGraphConfig.Field MAX_PREFETCHED_ROWS
```
    maximum number of rows prefetched during each round trip resultset-database
  - ERROR_HANDLING
```
public static final PartitionedGraphConfig.Field ERROR_HANDLING
```
    error handling configuration
  - LOCAL_DATE_FORMAT
```
public static final PartitionedGraphConfig.Field LOCAL_DATE_FORMAT
```
    array of local_date formats to use when loading and storing local_date properties. Please see DateTimeFormatter for a documentation of the format string
  - TIME_FORMAT
```
public static final PartitionedGraphConfig.Field TIME_FORMAT
```
    the time format to use when loading and storing time properties. Please see DateTimeFormatter for a documentation of the format string
  - TIMESTAMP_FORMAT
```
public static final PartitionedGraphConfig.Field TIMESTAMP_FORMAT
```
    the timestamp format to use when loading and storing timestamp properties. Please see DateTimeFormatter for a documentation of the format string
  - TIME_WITH_TIMEZONE_FORMAT
```
public static final PartitionedGraphConfig.Field TIME_WITH_TIMEZONE_FORMAT
```
    the time with timezone format to use when loading and storing time with timezone properties. Please see DateTimeFormatter for a documentation of the format string
  - TIMESTAMP_WITH_TIMEZONE_FORMAT
```
public static final PartitionedGraphConfig.Field TIMESTAMP_WITH_TIMEZONE_FORMAT
```
    the timestamp with timezone format to use when loading and storing timestamp with timezone properties. Please see DateTimeFormatter for a documentation of the format string
  - VECTOR_COMPONENT_DELIMITER
```
public static final PartitionedGraphConfig.Field VECTOR_COMPONENT_DELIMITER
```
    delimiter for the different components of vector properties
  - POINT2D
```
public static final PartitionedGraphConfig.Field POINT2D
```
    longitude and latitude as floating point values separated by a space
  - ATTRIBUTES
```
public static final PartitionedGraphConfig.Field ATTRIBUTES
```
    additional attributes needed to read/write the graph data
  - PASSWORD
```
public static final PartitionedGraphConfig.Field PASSWORD
```
    password to use when connecting to database
  - KEYSTORE_ALIAS
```
public static final PartitionedGraphConfig.Field KEYSTORE_ALIAS
```
    alias to the keystore to use when connecting to database
- Method Detail
  - values
```
public static PartitionedGraphConfig.Field[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (PartitionedGraphConfig.Field c : PartitionedGraphConfig.Field.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PartitionedGraphConfig.Field valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getKeyAliases
```
public java.util.List<java.lang.String> getKeyAliases()
```
    Description copied from interface: ConfigField
    
    Gets the key aliases of this field which are also recognized during parsing.
    
    Specified by:
    
    getKeyAliases in interface ConfigField
    
    Returns:
    
    the key aliases
  - getSingletonListKeyAliases
```
public java.util.List<java.lang.String> getSingletonListKeyAliases()
```
    Description copied from interface: ConfigField
    
    Gets the key aliases of this field which contain single values for lists and are also recognized during parsing.
    
    Specified by:
    
    getSingletonListKeyAliases in interface ConfigField
    
    Returns:
    
    the singleton list key aliases
  - getType
```
public java.lang.Class<?> getType()
```
    Description copied from interface: ConfigField
    
    Gets the type of this field.
    
    Specified by:
    
    getType in interface ConfigField
    
    Returns:
    
    the type
  - isRequired
```
public boolean isRequired()
```
    Description copied from interface: ConfigField
    
    Checks if this field is required.
    
    Specified by:
    
    isRequired in interface ConfigField
    
    Returns:
    
    true, if required
  - isArray
```
public boolean isArray()
```
    Description copied from interface: ConfigField
    
    Checks if this field is an array.
    
    Specified by:
    
    isArray in interface ConfigField
    
    Returns:
    
    true, if array
  - isPath
```
public boolean isPath()
```
    Description copied from interface: ConfigField
    
    Checks if this field is a path.
    
    Specified by:
    
    isPath in interface ConfigField
    
    Returns:
    
    true, if path
  - getDefaultVal
```
public java.lang.Object getDefaultVal()
```
    Description copied from interface: ConfigField
    
    Gets the default value of this field.
    
    Specified by:
    
    getDefaultVal in interface ConfigField
    
    Returns:
    
    the default value
  - toKey
```
public java.lang.String toKey()
```
    Description copied from interface: ConfigField
    
    Get the key of this field, which is how this field is represented in serialized form.
    
    Specified by:
    
    toKey in interface ConfigField
    
    Returns:
    
    the key.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<PartitionedGraphConfig.Field>
  - isSensitive
```
public boolean isSensitive()
```
    Description copied from interface: ConfigField
    
    Checks if this field holds a sensitive data.
    
    Specified by:
    
    isSensitive in interface ConfigField
    
    Returns:
    
    true, if use for sensitive data
  - isHidden
```
public boolean isHidden()
```
    Description copied from interface: ConfigField
    
    Checks if this field should be hidden. Hidden fields are used to hid desired field from the user and only allow it for internal usage.
    
    Specified by:
    
    isHidden in interface ConfigField
    
    Returns:
    
    true if field should be hidden, false otherwise

Enum PartitionedGraphConfig.Field

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.pgx.config.ConfigField

Enum Constant Detail

NAME

QUERIES

PREPARED_QUERIES

OPTIMIZED_FOR

VERTEX_ID_STRATEGY

EDGE_ID_STRATEGY

VERTEX_ID_TYPE

EDGE_ID_TYPE

ARRAY_COMPACTION_THRESHOLD

VERTEX_PROVIDERS

EDGE_PROVIDERS

LOADING

REDACTION_RULES

RULES_MAPPING

EXTERNAL_STORES

SOURCE_NAME

SOURCE_TYPE

MAX_BATCH_SIZE

ES_URL

ES_INDEX_NAME

PROXY_URL

SCROLL_TIME

USERNAME

NUM_CONNECTIONS

SCHEMA

JDBC_URL

DATA_SOURCE_ID

MAX_PREFETCHED_ROWS

ERROR_HANDLING

LOCAL_DATE_FORMAT

TIME_FORMAT

TIMESTAMP_FORMAT

TIME_WITH_TIMEZONE_FORMAT

TIMESTAMP_WITH_TIMEZONE_FORMAT

VECTOR_COMPONENT_DELIMITER

POINT2D

ATTRIBUTES

PASSWORD

KEYSTORE_ALIAS

Method Detail

values

valueOf

getKeyAliases

getSingletonListKeyAliases

getType

isRequired

isArray

isPath

getDefaultVal

toKey

toString

isSensitive

isHidden