GraphErrorHandlingConfig.Field (Oracle Graph Java API Reference for Property Graph Release 22.4 (F52518-01))

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

All Implemented Interfaces:

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

Enclosing class:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ENABLE_EDGE_ID_DUPLICATE_CHECK` if `true`, checks if there are duplicate edge IDs or not.
`ENABLE_VERTEX_ID_DUPLICATE_CHECK` if `true`, checks if there are duplicate vertex IDs or not.
`ON_DUPLICATE_ENTITY_ID` what to do when a duplicate vertex or edge ID is found
`ON_MISSED_PROP_KEY` what to do when missing property key is encountered
`ON_MISSING_VERTEX` what to do when a source or destination vertex of an edge is not found in a vertex data source.
`ON_PARSING_ISSUE` what to do when the data cannot be parsed correctly.
`ON_PROP_CONVERSION` what to do when different property type is encountered than specified, but coercion is possible
`ON_TYPE_MISMATCH` what to do when different property type is encountered than specified, but coercion is not possible
`ON_VECTOR_LENGTH_MISMATCH` what to do when a vector property has not the correct dimension

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 GraphErrorHandlingConfig.Field`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static GraphErrorHandlingConfig.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
  - ENABLE_EDGE_ID_DUPLICATE_CHECK
```
public static final GraphErrorHandlingConfig.Field ENABLE_EDGE_ID_DUPLICATE_CHECK
```
    if true, checks if there are duplicate edge IDs or not. If duplicates are found, ignores them or throws an error according to on_duplicate_entity_id. If the check is disabled, loading duplicate IDs cause an undefined behavior (loading might fail, or result in a graph in an invalid state)
  - ENABLE_VERTEX_ID_DUPLICATE_CHECK
```
public static final GraphErrorHandlingConfig.Field ENABLE_VERTEX_ID_DUPLICATE_CHECK
```
    if true, checks if there are duplicate vertex IDs or not. If duplicates are found, ignores them or throws an error according to on_duplicate_entity_id. If the check is disabled, loading duplicate IDs cause an undefined behavior (loading might fail, or result in a graph in an invalid state)
  - ON_DUPLICATE_ENTITY_ID
```
public static final GraphErrorHandlingConfig.Field ON_DUPLICATE_ENTITY_ID
```
    what to do when a duplicate vertex or edge ID is found
  - ON_MISSED_PROP_KEY
```
public static final GraphErrorHandlingConfig.Field ON_MISSED_PROP_KEY
```
    what to do when missing property key is encountered
  - ON_MISSING_VERTEX
```
public static final GraphErrorHandlingConfig.Field ON_MISSING_VERTEX
```
    what to do when a source or destination vertex of an edge is not found in a vertex data source.
  - ON_PARSING_ISSUE
```
public static final GraphErrorHandlingConfig.Field ON_PARSING_ISSUE
```
    what to do when the data cannot be parsed correctly. If set to silent, log_warn or log_warn_once, will attempt to continue loading. Some parsing issues may not be recoverable and provoke the end of loading.
  - ON_PROP_CONVERSION
```
public static final GraphErrorHandlingConfig.Field ON_PROP_CONVERSION
```
    what to do when different property type is encountered than specified, but coercion is possible
  - ON_TYPE_MISMATCH
```
public static final GraphErrorHandlingConfig.Field ON_TYPE_MISMATCH
```
    what to do when different property type is encountered than specified, but coercion is not possible
  - ON_VECTOR_LENGTH_MISMATCH
```
public static final GraphErrorHandlingConfig.Field ON_VECTOR_LENGTH_MISMATCH
```
    what to do when a vector property has not the correct dimension
- Method Detail
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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<GraphErrorHandlingConfig.Field>
  - valueOf
```
public static GraphErrorHandlingConfig.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
  - values
```
public static GraphErrorHandlingConfig.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 (GraphErrorHandlingConfig.Field c : GraphErrorHandlingConfig.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

Enum GraphErrorHandlingConfig.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

ENABLE_EDGE_ID_DUPLICATE_CHECK

ENABLE_VERTEX_ID_DUPLICATE_CHECK

ON_DUPLICATE_ENTITY_ID

ON_MISSED_PROP_KEY

ON_MISSING_VERTEX

ON_PARSING_ISSUE

ON_PROP_CONVERSION

ON_TYPE_MISMATCH

ON_VECTOR_LENGTH_MISMATCH

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isHidden

isPath

isRequired

isSensitive

toKey

toString

valueOf

values