PgHbaseGraphConfig.Field (Oracle Big Data Spatial and Graph In-memory Analyst Java API Reference v2.2.0 (E62127

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

All Implemented Interfaces:

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

Enclosing class:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ATTRIBUTES` additional attributes
`BLOCK_CACHE_SIZE` block_cache_size
`COMPRESSION` which HBase compression algorithm to use.
`DATA_BLOCK_ENCODING` which datablock encoding algorithm to use.
`DATE_FORMAT` the date format to use when loading and storing date properties.
`DB_ENGINE` underlying database engine
`EDGE_PROPS` specification of edge properties associated with graph
`ERROR_HANDLING` error handling configuration
`FORMAT` graph format (Note: `bin` is deprecated, use `pgb` instead)
`HADOOP_SEC_AUTH` Hadoop authentication string
`HBASE_SEC_AUTH` HBase authentication string
`HM_KERBEROS_PRINCIPAL` HM Kerberos principal
`INITIAL_EDGE_NUM_REGIONS` how many initial edge regions defined for the HBase tables
`INITIAL_VERTEX_NUM_REGIONS` how many initial vertex regions defined for the HBase tables
`KEYTAB` path to keytab file
`LOADING` loading-specific configuration
`MAX_NUM_CONNECTIONS` maximum number of database connections to use when reading the graph
`NAME` prefix of the table name (for edge and vertex tables)
`RS_KERBEROS_PRINCIPAL` RS Kerberos principal
`SPLITS_PER_REGION` how many splits per region to use when scanning vertices/edges
`USER_PRINCIPAL` User principal
`VERTEX_PROPS` specification of vertex properties associated with graph
`ZK_CLIENT_PORT` ZooKeeper client port
`ZK_NODE_PARENT` ZooKeeper node parent
`ZK_QUORUM` ZooKeeper Quorum value
`ZK_SESSION_TIMEOUT` ZooKeeper session timeout (in milliseconds)

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.
`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 PgHbaseGraphConfig.Field`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static PgHbaseGraphConfig.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 PgHbaseGraphConfig.Field ATTRIBUTES
```
    additional attributes
  - BLOCK_CACHE_SIZE
```
public static final PgHbaseGraphConfig.Field BLOCK_CACHE_SIZE
```
    block_cache_size
  - COMPRESSION
```
public static final PgHbaseGraphConfig.Field COMPRESSION
```
    which HBase compression algorithm to use. Check HBase documentation for list of supported algorithms
  - DATA_BLOCK_ENCODING
```
public static final PgHbaseGraphConfig.Field DATA_BLOCK_ENCODING
```
    which datablock encoding algorithm to use. Supported values are 'none', 'prefix', 'diff', 'fast_diff' and 'prefix_tree'. See the DataBlockEncoding class in the org.apache.hadoop.hbase.io.encoding package for details.
  - DATE_FORMAT
```
public static final PgHbaseGraphConfig.Field DATE_FORMAT
```
    the date format to use when loading and storing date properties. Please see SimpleDateFormat for a documentation of the format string
  - DB_ENGINE
```
public static final PgHbaseGraphConfig.Field DB_ENGINE
```
    underlying database engine
  - EDGE_PROPS
```
public static final PgHbaseGraphConfig.Field EDGE_PROPS
```
    specification of edge properties associated with graph
  - ERROR_HANDLING
```
public static final PgHbaseGraphConfig.Field ERROR_HANDLING
```
    error handling configuration
  - FORMAT
```
public static final PgHbaseGraphConfig.Field FORMAT
```
    graph format (Note: bin is deprecated, use pgb instead)
  - HADOOP_SEC_AUTH
```
public static final PgHbaseGraphConfig.Field HADOOP_SEC_AUTH
```
    Hadoop authentication string
  - HBASE_SEC_AUTH
```
public static final PgHbaseGraphConfig.Field HBASE_SEC_AUTH
```
    HBase authentication string
  - HM_KERBEROS_PRINCIPAL
```
public static final PgHbaseGraphConfig.Field HM_KERBEROS_PRINCIPAL
```
    HM Kerberos principal
  - INITIAL_EDGE_NUM_REGIONS
```
public static final PgHbaseGraphConfig.Field INITIAL_EDGE_NUM_REGIONS
```
    how many initial edge regions defined for the HBase tables
  - INITIAL_VERTEX_NUM_REGIONS
```
public static final PgHbaseGraphConfig.Field INITIAL_VERTEX_NUM_REGIONS
```
    how many initial vertex regions defined for the HBase tables
  - KEYTAB
```
public static final PgHbaseGraphConfig.Field KEYTAB
```
    path to keytab file
  - LOADING
```
public static final PgHbaseGraphConfig.Field LOADING
```
    loading-specific configuration
  - MAX_NUM_CONNECTIONS
```
public static final PgHbaseGraphConfig.Field MAX_NUM_CONNECTIONS
```
    maximum number of database connections to use when reading the graph
  - NAME
```
public static final PgHbaseGraphConfig.Field NAME
```
    prefix of the table name (for edge and vertex tables)
  - RS_KERBEROS_PRINCIPAL
```
public static final PgHbaseGraphConfig.Field RS_KERBEROS_PRINCIPAL
```
    RS Kerberos principal
  - SPLITS_PER_REGION
```
public static final PgHbaseGraphConfig.Field SPLITS_PER_REGION
```
    how many splits per region to use when scanning vertices/edges
  - USER_PRINCIPAL
```
public static final PgHbaseGraphConfig.Field USER_PRINCIPAL
```
    User principal
  - VERTEX_PROPS
```
public static final PgHbaseGraphConfig.Field VERTEX_PROPS
```
    specification of vertex properties associated with graph
  - ZK_CLIENT_PORT
```
public static final PgHbaseGraphConfig.Field ZK_CLIENT_PORT
```
    ZooKeeper client port
  - ZK_NODE_PARENT
```
public static final PgHbaseGraphConfig.Field ZK_NODE_PARENT
```
    ZooKeeper node parent
  - ZK_QUORUM
```
public static final PgHbaseGraphConfig.Field ZK_QUORUM
```
    ZooKeeper Quorum value
  - ZK_SESSION_TIMEOUT
```
public static final PgHbaseGraphConfig.Field ZK_SESSION_TIMEOUT
```
    ZooKeeper session timeout (in milliseconds)
- 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
  - 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<PgHbaseGraphConfig.Field>
  - valueOf
```
public static PgHbaseGraphConfig.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 PgHbaseGraphConfig.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 (PgHbaseGraphConfig.Field c : PgHbaseGraphConfig.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

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

BLOCK_CACHE_SIZE

COMPRESSION

DATA_BLOCK_ENCODING

DATE_FORMAT

DB_ENGINE

EDGE_PROPS

ERROR_HANDLING

FORMAT

HADOOP_SEC_AUTH

HBASE_SEC_AUTH

HM_KERBEROS_PRINCIPAL

INITIAL_EDGE_NUM_REGIONS

INITIAL_VERTEX_NUM_REGIONS

KEYTAB

LOADING

MAX_NUM_CONNECTIONS

NAME

RS_KERBEROS_PRINCIPAL

SPLITS_PER_REGION

USER_PRINCIPAL

VERTEX_PROPS

ZK_CLIENT_PORT

ZK_NODE_PARENT

ZK_QUORUM

ZK_SESSION_TIMEOUT

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isPath

isRequired

toKey

toString

valueOf

values