TwoTablesSparkGraphConfig.Field (Oracle Big Data Spatial and Graph In-memory Analyst Java API Reference v2.4.0 (E62127-06))

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

All Implemented Interfaces:

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

Enclosing class:

TwoTablesSparkGraphConfig
```
public static enum TwoTablesSparkGraphConfig.Field
extends java.lang.Enum<TwoTablesSparkGraphConfig.Field>
implements ConfigField
```
Fields of PGX Engine Two Tables Spark Graph Config

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ATTRIBUTES` additional attributes needed to read/write the graph data
`DATA_FORMAT` type of the spark data format
`DATASTORE` underlying datastore
`DATE_FORMAT` the date format to use when loading and storing date properties.
`EDGE_PROPS` specification of edge properties associated with graph
`EDGES_KEY_COLUMN` name of primary key column in edges table
`EDGES_LABEL_COLUMN` column name for edge label
`ERROR_HANDLING` error handling configuration
`FORMAT` graph format (Note: `bin` is deprecated, use `pgb` instead)
`FROM_NID_COLUMN` column name for source node
`LISTENING_SOCKET_TIMEOUT` PGX side listening socket will be expired after this timeout value (default: 30000 ms, 30 secs)
`LOADING` loading-specific configuration
`LOCAL_DATE_FORMAT` array of local_date formats to use when loading and storing local_date properties.
`NODES_KEY_COLUMN` name of primary key column in nodes table
`NODES_LABEL_COLUMN` column name for node label
`NUM_SPARK_EDGE_WORKERS` number of available spark workers for edge table
`NUM_SPARK_NODE_WORKERS` number of available spark workers for node table
`POINT2D` longitude and latitude as floating point values separated by a space
`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.
`TO_NID_COLUMN` column name for destination node
`VERTEX_ID_TYPE` type of the vertex ID
`VERTEX_PROPS` specification of vertex properties associated with graph

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`	`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 TwoTablesSparkGraphConfig.Field`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static TwoTablesSparkGraphConfig.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
  - ATTRIBUTES
```
public static final TwoTablesSparkGraphConfig.Field ATTRIBUTES
```
    additional attributes needed to read/write the graph data
  - DATA_FORMAT
```
public static final TwoTablesSparkGraphConfig.Field DATA_FORMAT
```
    type of the spark data format
  - DATASTORE
```
public static final TwoTablesSparkGraphConfig.Field DATASTORE
```
    underlying datastore
  - DATE_FORMAT
```
public static final TwoTablesSparkGraphConfig.Field DATE_FORMAT
```
    the date format to use when loading and storing date properties. Please see SimpleDateFormat for a documentation of the format string
  - EDGE_PROPS
```
public static final TwoTablesSparkGraphConfig.Field EDGE_PROPS
```
    specification of edge properties associated with graph
  - EDGES_KEY_COLUMN
```
public static final TwoTablesSparkGraphConfig.Field EDGES_KEY_COLUMN
```
    name of primary key column in edges table
  - EDGES_LABEL_COLUMN
```
public static final TwoTablesSparkGraphConfig.Field EDGES_LABEL_COLUMN
```
    column name for edge label
  - ERROR_HANDLING
```
public static final TwoTablesSparkGraphConfig.Field ERROR_HANDLING
```
    error handling configuration
  - FORMAT
```
public static final TwoTablesSparkGraphConfig.Field FORMAT
```
    graph format (Note: bin is deprecated, use pgb instead)
  - FROM_NID_COLUMN
```
public static final TwoTablesSparkGraphConfig.Field FROM_NID_COLUMN
```
    column name for source node
  - LISTENING_SOCKET_TIMEOUT
```
public static final TwoTablesSparkGraphConfig.Field LISTENING_SOCKET_TIMEOUT
```
    PGX side listening socket will be expired after this timeout value (default: 30000 ms, 30 secs)
  - LOADING
```
public static final TwoTablesSparkGraphConfig.Field LOADING
```
    loading-specific configuration
  - LOCAL_DATE_FORMAT
```
public static final TwoTablesSparkGraphConfig.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
  - NODES_KEY_COLUMN
```
public static final TwoTablesSparkGraphConfig.Field NODES_KEY_COLUMN
```
    name of primary key column in nodes table
  - NODES_LABEL_COLUMN
```
public static final TwoTablesSparkGraphConfig.Field NODES_LABEL_COLUMN
```
    column name for node label
  - NUM_SPARK_EDGE_WORKERS
```
public static final TwoTablesSparkGraphConfig.Field NUM_SPARK_EDGE_WORKERS
```
    number of available spark workers for edge table
  - NUM_SPARK_NODE_WORKERS
```
public static final TwoTablesSparkGraphConfig.Field NUM_SPARK_NODE_WORKERS
```
    number of available spark workers for node table
  - POINT2D
```
public static final TwoTablesSparkGraphConfig.Field POINT2D
```
    longitude and latitude as floating point values separated by a space
  - TIME_FORMAT
```
public static final TwoTablesSparkGraphConfig.Field TIME_FORMAT
```
    the time format to use when loading and storing time properties. Please see DateTimeFormatter for a documentation of the format string
  - TIME_WITH_TIMEZONE_FORMAT
```
public static final TwoTablesSparkGraphConfig.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_FORMAT
```
public static final TwoTablesSparkGraphConfig.Field TIMESTAMP_FORMAT
```
    the timestamp format to use when loading and storing timestamp properties. Please see DateTimeFormatter for a documentation of the format string
  - TIMESTAMP_WITH_TIMEZONE_FORMAT
```
public static final TwoTablesSparkGraphConfig.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
  - TO_NID_COLUMN
```
public static final TwoTablesSparkGraphConfig.Field TO_NID_COLUMN
```
    column name for destination node
  - VERTEX_ID_TYPE
```
public static final TwoTablesSparkGraphConfig.Field VERTEX_ID_TYPE
```
    type of the vertex ID
  - VERTEX_PROPS
```
public static final TwoTablesSparkGraphConfig.Field VERTEX_PROPS
```
    specification of vertex properties associated with graph
- 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
  - 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<TwoTablesSparkGraphConfig.Field>
  - valueOf
```
public static TwoTablesSparkGraphConfig.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 TwoTablesSparkGraphConfig.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 (TwoTablesSparkGraphConfig.Field c : TwoTablesSparkGraphConfig.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

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

ATTRIBUTES

DATA_FORMAT

DATASTORE

DATE_FORMAT

EDGE_PROPS

EDGES_KEY_COLUMN

EDGES_LABEL_COLUMN

ERROR_HANDLING

FORMAT

FROM_NID_COLUMN

LISTENING_SOCKET_TIMEOUT

LOADING

LOCAL_DATE_FORMAT

NODES_KEY_COLUMN

NODES_LABEL_COLUMN

NUM_SPARK_EDGE_WORKERS

NUM_SPARK_NODE_WORKERS

POINT2D

TIME_FORMAT

TIME_WITH_TIMEZONE_FORMAT

TIMESTAMP_FORMAT

TIMESTAMP_WITH_TIMEZONE_FORMAT

TO_NID_COLUMN

VERTEX_ID_TYPE

VERTEX_PROPS

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isPath

isRequired

isSensitive

toKey

toString

valueOf

values