EsEntityProviderConfig.Field (Oracle Graph Java API Reference for Property Graph Release 22.3 (F59609-02))

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

All Implemented Interfaces:

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

Enclosing class:

EsEntityProviderConfig
```
public static enum EsEntityProviderConfig.Field
extends java.lang.Enum<EsEntityProviderConfig.Field>
implements ConfigField
```
Fields of PGX Engine Es Entity Provider Config

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ATTRIBUTES` additional attributes needed to read/write the graph data
`DESTINATION_FIELD` name of the field in the Elasticsearch index containing the keys of the destination vertices
`DESTINATION_VERTEX_PROVIDER` name of the destination vertex provider to be used for this edge provider
`ERROR_HANDLING` error handling configuration
`ES_INDEX_NAME` Index name on the Elasticsearch server form which graph data is loaded
`ES_QUERY` Elasticsearch query expressed as escaped JSON string
`ES_URL` Elasticsearch URL pointing to an Elasticsearch instance
`FORMAT` provider format
`HAS_KEYS` indicates if the provided entities data have keys
`KEY_FIELD` name of the field in the Elasticsearch index containing the keys of the entity
`KEY_TYPE` type of the keys
`KEYSTORE_ALIAS` alias to the keystore to use when connecting to database
`LABEL` label for the entities loaded from this provider
`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
`NAME` entity provider name
`PASSWORD` password to use when connecting to database
`POINT2D` longitude and latitude as floating point values separated by a space
`PROPS` specification of the properties associated with this entity provider
`PROXY_URL` proxy server URL to be used for connection to es_url
`SCROLL_TIME` time to keep Elasticsearch-scroll alive, batch data needs to be received and processed in that time window.
`SOURCE_FIELD` name of the field in the Elasticsearch index containing the keys of the source vertices
`SOURCE_VERTEX_PROVIDER` name of the source vertex provider to be used for this edge provider
`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 Elasticsearch instance
`VECTOR_COMPONENT_DELIMITER` delimiter for the different components of vector properties

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 EsEntityProviderConfig.Field`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static EsEntityProviderConfig.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 EsEntityProviderConfig.Field ATTRIBUTES
```
    additional attributes needed to read/write the graph data
  - DESTINATION_FIELD
```
public static final EsEntityProviderConfig.Field DESTINATION_FIELD
```
    name of the field in the Elasticsearch index containing the keys of the destination vertices
  - DESTINATION_VERTEX_PROVIDER
```
public static final EsEntityProviderConfig.Field DESTINATION_VERTEX_PROVIDER
```
    name of the destination vertex provider to be used for this edge provider
  - ERROR_HANDLING
```
public static final EsEntityProviderConfig.Field ERROR_HANDLING
```
    error handling configuration
  - ES_INDEX_NAME
```
public static final EsEntityProviderConfig.Field ES_INDEX_NAME
```
    Index name on the Elasticsearch server form which graph data is loaded
  - ES_QUERY
```
public static final EsEntityProviderConfig.Field ES_QUERY
```
    Elasticsearch query expressed as escaped JSON string
  - ES_URL
```
public static final EsEntityProviderConfig.Field ES_URL
```
    Elasticsearch URL pointing to an Elasticsearch instance
  - FORMAT
```
public static final EsEntityProviderConfig.Field FORMAT
```
    provider format
  - HAS_KEYS
```
public static final EsEntityProviderConfig.Field HAS_KEYS
```
    indicates if the provided entities data have keys
  - KEY_FIELD
```
public static final EsEntityProviderConfig.Field KEY_FIELD
```
    name of the field in the Elasticsearch index containing the keys of the entity
  - KEY_TYPE
```
public static final EsEntityProviderConfig.Field KEY_TYPE
```
    type of the keys
  - KEYSTORE_ALIAS
```
public static final EsEntityProviderConfig.Field KEYSTORE_ALIAS
```
    alias to the keystore to use when connecting to database
  - LABEL
```
public static final EsEntityProviderConfig.Field LABEL
```
    label for the entities loaded from this provider
  - LOADING
```
public static final EsEntityProviderConfig.Field LOADING
```
    loading-specific configuration
  - LOCAL_DATE_FORMAT
```
public static final EsEntityProviderConfig.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
  - MAX_BATCH_SIZE
```
public static final EsEntityProviderConfig.Field MAX_BATCH_SIZE
```
    maximal batch size of Elasticsearch response objects
  - NAME
```
public static final EsEntityProviderConfig.Field NAME
```
    entity provider name
  - PASSWORD
```
public static final EsEntityProviderConfig.Field PASSWORD
```
    password to use when connecting to database
  - POINT2D
```
public static final EsEntityProviderConfig.Field POINT2D
```
    longitude and latitude as floating point values separated by a space
  - PROPS
```
public static final EsEntityProviderConfig.Field PROPS
```
    specification of the properties associated with this entity provider
  - PROXY_URL
```
public static final EsEntityProviderConfig.Field PROXY_URL
```
    proxy server URL to be used for connection to es_url
  - SCROLL_TIME
```
public static final EsEntityProviderConfig.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.
  - SOURCE_FIELD
```
public static final EsEntityProviderConfig.Field SOURCE_FIELD
```
    name of the field in the Elasticsearch index containing the keys of the source vertices
  - SOURCE_VERTEX_PROVIDER
```
public static final EsEntityProviderConfig.Field SOURCE_VERTEX_PROVIDER
```
    name of the source vertex provider to be used for this edge provider
  - TIME_FORMAT
```
public static final EsEntityProviderConfig.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 EsEntityProviderConfig.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 EsEntityProviderConfig.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 EsEntityProviderConfig.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
  - USERNAME
```
public static final EsEntityProviderConfig.Field USERNAME
```
    username to use when connecting to an Elasticsearch instance
  - VECTOR_COMPONENT_DELIMITER
```
public static final EsEntityProviderConfig.Field VECTOR_COMPONENT_DELIMITER
```
    delimiter for the different components of vector properties
- 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<EsEntityProviderConfig.Field>
  - valueOf
```
public static EsEntityProviderConfig.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 EsEntityProviderConfig.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 (EsEntityProviderConfig.Field c : EsEntityProviderConfig.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared

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

DESTINATION_FIELD

DESTINATION_VERTEX_PROVIDER

ERROR_HANDLING

ES_INDEX_NAME

ES_QUERY

ES_URL

FORMAT

HAS_KEYS

KEY_FIELD

KEY_TYPE

KEYSTORE_ALIAS

LABEL

LOADING

LOCAL_DATE_FORMAT

MAX_BATCH_SIZE

NAME

PASSWORD

POINT2D

PROPS

PROXY_URL

SCROLL_TIME

SOURCE_FIELD

SOURCE_VERTEX_PROVIDER

TIME_FORMAT

TIME_WITH_TIMEZONE_FORMAT

TIMESTAMP_FORMAT

TIMESTAMP_WITH_TIMEZONE_FORMAT

USERNAME

VECTOR_COMPONENT_DELIMITER

Method Detail

getDefaultVal

getKeyAliases

getSingletonListKeyAliases

getType

isArray

isHidden

isPath

isRequired

isSensitive

toKey

toString

valueOf

values