java.lang.Object
- oracle.pgx.config.AbstractConfig
- - oracle.pgx.config.EntityProviderConfig
  - - oracle.pgx.config.AbstractEsEntityProviderConfig
    - - oracle.pgx.config.EsEntityProviderConfig

All Implemented Interfaces:

CommonLoadableConfig<ProviderFormat>, EsConnectionConfig, oracle.pgx.config.internal.ConvertibleToEntityProviderConfigBuilder
```
@Generated("config_generator.py")
public class EsEntityProviderConfig
extends AbstractEsEntityProviderConfig
```
PGX Engine Es Entity Provider Config

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class EsEntityProviderConfig.Field
Fields of PGX Engine Es Entity Provider Config

Field Summary
- Fields inherited from class oracle.pgx.config.AbstractConfig
  ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.Map`	`getAttributes()`	additional attributes needed to read/write the graph data
`static EsEntityProviderConfig.Field[]`	`getConfigFields()`
`java.lang.String`	`getDestinationField()`	name of the field in the Elasticsearch index containing the keys of the destination vertices
`java.lang.String`	`getDestinationVertexProvider()`	name of the destination vertex provider to be used for this edge provider
`GraphErrorHandlingConfig`	`getErrorHandling()`	error handling configuration
`java.lang.String`	`getEsIndexName()`	Index name on the Elasticsearch server form which graph data is loaded
`java.lang.String`	`getEsQuery()`	Elasticsearch query expressed as escaped JSON string
`java.lang.String`	`getEsUrl()`	Elasticsearch URL pointing to an Elasticsearch instance
`ProviderFormat`	`getFormat()`	provider format
`java.lang.String`	`getKeyField()`	name of the field in the Elasticsearch index containing the keys of the entity
`java.lang.String`	`getKeystoreAlias()`	alias to the keystore to use when connecting to database
`IdType`	`getKeyType()`	type of the keys
`java.lang.String`	`getLabel()`	label for the entities loaded from this provider
`java.util.Map<java.lang.String,java.lang.Object>`	`getLeftoverValues()`	Gets the values that do not belong to any field.
`ProviderLoadingConfig`	`getLoading()`	loading-specific configuration
`java.util.List<java.lang.String>`	`getLocalDateFormat()`	array of local_date formats to use when loading and storing local_date properties.
`java.lang.Integer`	`getMaxBatchSize()`	maximal batch size of Elasticsearch response objects
`java.lang.String`	`getName()`	entity provider name
`java.lang.String`	`getPoint2d()`	longitude and latitude as floating point values separated by a space
`java.util.List<GraphPropertyConfig>`	`getProps()`	specification of the properties associated with this entity provider
`java.lang.String`	`getProxyUrl()`	proxy server URL to be used for connection to es_url
`java.lang.String`	`getScrollTime()`	time to keep Elasticsearch-scroll alive, batch data needs to be received and processed in that time window.
`java.lang.String`	`getSourceField()`	name of the field in the Elasticsearch index containing the keys of the source vertices
`java.lang.String`	`getSourceVertexProvider()`	name of the source vertex provider to be used for this edge provider
`java.util.List<java.lang.String>`	`getTimeFormat()`	the time format to use when loading and storing time properties.
`java.util.List<java.lang.String>`	`getTimestampFormat()`	the timestamp format to use when loading and storing timestamp properties.
`java.util.List<java.lang.String>`	`getTimestampWithTimezoneFormat()`	the timestamp with timezone format to use when loading and storing timestamp with timezone properties.
`java.util.List<java.lang.String>`	`getTimeWithTimezoneFormat()`	the time with timezone format to use when loading and storing time with timezone properties.
`java.lang.String`	`getUsername()`	username to use when connecting to an Elasticsearch instance
`java.util.Map<EsEntityProviderConfig.Field,java.lang.Object>`	`getValues()`	Gets the parsed values.
`java.util.Map<EsEntityProviderConfig.Field,java.lang.Object>`	`getValuesWithoutDefaults()`	Gets the values without defaults.
`java.lang.Character`	`getVectorComponentDelimiter()`	delimiter for the different components of vector properties
`boolean`	`hasDefaultValue(EsEntityProviderConfig.Field field)`	Checks for default value.
`java.lang.Boolean`	`hasKeys()`	indicates if the provided entities data have keys
`boolean`	`isEmpty()`	Checks if it's empty.
`static EsEntityProviderConfig`	`parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)`	Parses an input stream.
`static EsEntityProviderConfig`	`parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)`	Parses a raw key/value mapping.
`static EsEntityProviderConfig`	`parse(java.util.Properties props, boolean strict)`	Parses a properties file.
`java.lang.String`	`toString()`
`java.lang.String`	`toString(boolean hideSensitiveData)`

Methods inherited from class oracle.pgx.config.AbstractEsEntityProviderConfig
getEsIndexName, getEsUrl, getKeystoreAlias, getLoadedEsIndexName, getMaxBatchSize, getScrollTime, getUsername, hashCode, supportsVectorProperties, toEntityProviderConfigBuilder

Methods inherited from class oracle.pgx.config.EntityProviderConfig
getDestinationVertexKeyType, getPropertyDefault, getPropertyDimension, getPropertyName, getPropertyType, getSourceVertexKeyType, getValidatedLabel, isKeyMappingEnabled, isLabelLoadingEnabled, numProperties, supportsPropertyColumn, supportsPropertyColumn, supportsVectorProperties

Methods inherited from class oracle.pgx.config.AbstractConfig
getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable

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

Methods inherited from interface oracle.pgx.config.CommonLoadableConfig
createLocalDateFormat, createTimeFormat, createTimestampFormat, createTimestampWithTimezoneFormat, createTimeWithTimezoneFormat

- Method Detail
  - parse
```
public static EsEntityProviderConfig parse(java.io.InputStream is,
                                           boolean strict,
                                           java.lang.String parentPath)
                                    throws java.io.IOException
```
    Parses an input stream.
    
    Parameters:
    
    is - the input stream
    
    strict - if true, parses in strict mode
    
    parentPath - if not null, resolves relative paths against this parentPath
    
    Returns:
    
    the parsed graph config
    
    Throws:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - parse
```
public static EsEntityProviderConfig parse(java.util.Map<java.lang.String,java.lang.Object> raw,
                                           boolean strict,
                                           java.lang.String parentPath)
```
    Parses a raw key/value mapping.
    
    Parameters:
    
    raw - the raw key/value mapping to parse
    
    strict - if true, parses in strict mode
    
    parentPath - if not null, resolves relative paths against this parentPath
    
    Returns:
    
    the parsed graph config
  - parse
```
public static EsEntityProviderConfig parse(java.util.Properties props,
                                           boolean strict)
```
    Parses a properties file.
    
    Parameters:
    
    props - the properties to parse
    
    strict - if true, parses in strict mode
    
    Returns:
    
    the parsed graph config
  - getConfigFields
```
public static EsEntityProviderConfig.Field[] getConfigFields()
```
  - getValues
```
public java.util.Map<EsEntityProviderConfig.Field,java.lang.Object> getValues()
```
    Gets the parsed values.
    
    Specified by:
    
    getValues in class AbstractConfig
    
    Returns:
    
    the parsed values
  - isEmpty
```
public boolean isEmpty()
```
    Checks if it's empty.
    
    Returns:
    
    true, if the Map 'values' is empty.
  - hasDefaultValue
```
public boolean hasDefaultValue(EsEntityProviderConfig.Field field)
```
    Checks for default value.
    
    Specified by:
    
    hasDefaultValue in class AbstractEsEntityProviderConfig
    
    Parameters:
    
    field - the field
    
    Returns:
    
    true, if value for given field is the default value
  - getValuesWithoutDefaults
```
public java.util.Map<EsEntityProviderConfig.Field,java.lang.Object> getValuesWithoutDefaults()
```
    Gets the values without defaults.
    
    Returns:
    
    the values without defaults
  - getLeftoverValues
```
public java.util.Map<java.lang.String,java.lang.Object> getLeftoverValues()
```
    Gets the values that do not belong to any field.
    
    Returns:
    
    the values that do not belong to any field
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.String toString(boolean hideSensitiveData)
```
  - getEsQuery
```
public java.lang.String getEsQuery()
```
    Elasticsearch query expressed as escaped JSON string
  - getKeyField
```
public java.lang.String getKeyField()
```
    name of the field in the Elasticsearch index containing the keys of the entity
    
    Specified by:
    
    getKeyField in class AbstractEsEntityProviderConfig
  - getSourceField
```
public java.lang.String getSourceField()
```
    name of the field in the Elasticsearch index containing the keys of the source vertices
    
    Specified by:
    
    getSourceField in class AbstractEsEntityProviderConfig
  - getDestinationField
```
public java.lang.String getDestinationField()
```
    name of the field in the Elasticsearch index containing the keys of the destination vertices
    
    Specified by:
    
    getDestinationField in class AbstractEsEntityProviderConfig
  - getMaxBatchSize
```
public java.lang.Integer getMaxBatchSize()
```
    maximal batch size of Elasticsearch response objects
    
    Returns:
    
    the maximum number of requested docs
  - getEsUrl
```
public java.lang.String getEsUrl()
```
    Elasticsearch URL pointing to an Elasticsearch instance
    
    Returns:
    
    the Es URL
  - getEsIndexName
```
public java.lang.String getEsIndexName()
```
    Index name on the Elasticsearch server form which graph data is loaded
    
    Specified by:
    
    getEsIndexName in interface EsConnectionConfig
    
    Specified by:
    
    getEsIndexName in class AbstractEsEntityProviderConfig
    
    Returns:
    
    the Es Index
  - getProxyUrl
```
public java.lang.String getProxyUrl()
```
    proxy server URL to be used for connection to es_url
    
    Returns:
    
    the proxy URL
  - getScrollTime
```
public java.lang.String getScrollTime()
```
    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.
    
    Returns:
    
    the Elasticsearch scroll time
  - getUsername
```
public java.lang.String getUsername()
```
    username to use when connecting to an Elasticsearch instance
    
    Returns:
    
    the username
  - getName
```
public java.lang.String getName()
```
    entity provider name
    
    Specified by:
    
    getName in interface CommonLoadableConfig<ProviderFormat>
    
    Specified by:
    
    getName in class EntityProviderConfig
    
    Returns:
    
    the name of the provider
  - getLabel
```
public java.lang.String getLabel()
```
    label for the entities loaded from this provider
    
    Specified by:
    
    getLabel in class EntityProviderConfig
    
    Returns:
    
    the custom label
  - getFormat
```
public ProviderFormat getFormat()
```
    provider format
    
    Returns:
    
    the format
  - getProps
```
public java.util.List<GraphPropertyConfig> getProps()
```
    specification of the properties associated with this entity provider
    
    Specified by:
    
    getProps in class EntityProviderConfig
    
    Returns:
    
    the list of vertex properties
  - getKeyType
```
public IdType getKeyType()
```
    type of the keys
    
    Specified by:
    
    getKeyType in class EntityProviderConfig
    
    Returns:
    
    the key type
  - getSourceVertexProvider
```
public java.lang.String getSourceVertexProvider()
```
    name of the source vertex provider to be used for this edge provider
    
    Specified by:
    
    getSourceVertexProvider in class EntityProviderConfig
    
    Returns:
    
    the name of the source vertex provider
  - getDestinationVertexProvider
```
public java.lang.String getDestinationVertexProvider()
```
    name of the destination vertex provider to be used for this edge provider
    
    Specified by:
    
    getDestinationVertexProvider in class EntityProviderConfig
    
    Returns:
    
    the name of the destination vertex provider
  - getLoading
```
public ProviderLoadingConfig getLoading()
```
    loading-specific configuration
    
    Specified by:
    
    getLoading in class EntityProviderConfig
    
    Returns:
    
    the loading configuration
  - hasKeys
```
public java.lang.Boolean hasKeys()
```
    indicates if the provided entities data have keys
    
    Specified by:
    
    hasKeys in class EntityProviderConfig
  - getErrorHandling
```
public GraphErrorHandlingConfig getErrorHandling()
```
    error handling configuration
    
    Returns:
    
    the error handling configuration
  - getLocalDateFormat
```
public java.util.List<java.lang.String> getLocalDateFormat()
```
    array of local_date formats to use when loading and storing local_date properties. Please see DateTimeFormatter for a documentation of the format string
    
    Returns:
    
    the date format
  - getTimeFormat
```
public java.util.List<java.lang.String> getTimeFormat()
```
    the time format to use when loading and storing time properties. Please see DateTimeFormatter for a documentation of the format string
    
    Returns:
    
    the time format
  - getTimestampFormat
```
public java.util.List<java.lang.String> getTimestampFormat()
```
    the timestamp format to use when loading and storing timestamp properties. Please see DateTimeFormatter for a documentation of the format string
    
    Returns:
    
    the timestamp format
  - getTimeWithTimezoneFormat
```
public java.util.List<java.lang.String> getTimeWithTimezoneFormat()
```
    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
    
    Returns:
    
    the time with timezone format
  - getTimestampWithTimezoneFormat
```
public java.util.List<java.lang.String> getTimestampWithTimezoneFormat()
```
    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
    
    Returns:
    
    the timestamp with timezone format
  - getVectorComponentDelimiter
```
public java.lang.Character getVectorComponentDelimiter()
```
    delimiter for the different components of vector properties
  - getPoint2d
```
public java.lang.String getPoint2d()
```
    longitude and latitude as floating point values separated by a space
  - getAttributes
```
public java.util.Map getAttributes()
```
    additional attributes needed to read/write the graph data
    
    Returns:
    
    the map of attributes
  - getKeystoreAlias
```
public java.lang.String getKeystoreAlias()
```
    alias to the keystore to use when connecting to database
    
    Specified by:
    
    getKeystoreAlias in interface CommonLoadableConfig<ProviderFormat>
    
    Specified by:
    
    getKeystoreAlias in class AbstractEsEntityProviderConfig
    
    Returns:
    
    the keystore alias or null if underlying format does not require a keystore
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class AbstractEsEntityProviderConfig

Class EsEntityProviderConfig

Nested Class Summary

Field Summary

Fields inherited from class oracle.pgx.config.AbstractConfig

Method Summary

Methods inherited from class oracle.pgx.config.AbstractEsEntityProviderConfig

Methods inherited from class oracle.pgx.config.EntityProviderConfig

Methods inherited from class oracle.pgx.config.AbstractConfig

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.pgx.config.CommonLoadableConfig

Method Detail

parse

parse

parse

getConfigFields

getValues

isEmpty

hasDefaultValue

getValuesWithoutDefaults

getLeftoverValues

toString

toString

getEsQuery

getKeyField

getSourceField

getDestinationField

getMaxBatchSize

getEsUrl

getEsIndexName

getProxyUrl

getScrollTime

getUsername

getName

getLabel

getFormat

getProps

getKeyType

getSourceVertexProvider

getDestinationVertexProvider

getLoading

hasKeys

getErrorHandling

getLocalDateFormat

getTimeFormat

getTimestampFormat

getTimeWithTimezoneFormat

getTimestampWithTimezoneFormat

getVectorComponentDelimiter

getPoint2d

getAttributes

getKeystoreAlias

equals